# The Intersight OpenAPI specification. # Created on 2020-08-14T01:09:46Z openapi: 3.0.2 info: description: |- Cisco Intersight is a management platform delivered as a service with embedded analytics for your Cisco and 3rd party IT infrastructure. This platform offers an intelligent level of management that enables IT organizations to analyze, simplify, and automate their environments in more advanced ways than the prior generations of tools. Cisco Intersight provides an integrated and intuitive management experience for resources in the traditional data center as well as at the edge. With flexible deployment options to address complex security needs, getting started with Intersight is quick and easy. Cisco Intersight has deep integration with Cisco UCS and HyperFlex systems allowing for remote deployment, configuration, and ongoing maintenance. The model-based deployment works for a single system in a remote location or hundreds of systems in a data center and enables rapid, standardized configuration and deployment. It also streamlines maintaining those systems whether you are working with small or very large configurations. The Intersight OpenAPI document defines the complete set of properties that are returned in the HTTP response. From that perspective, a client can expect that no additional properties are returned, unless these properties are explicitly defined in the OpenAPI document. However, when a client uses an older version of the Intersight OpenAPI document, the server may send additional properties because the software is more recent than the client. In that case, the client may receive properties that it does not know about. Some generated SDKs perform a strict validation of the HTTP response body against the OpenAPI document. This document was created on 2020-08-14T01:09:46Z. version: 0.0.1-123 title: Cisco Intersight license: name: MIT url: https://opensource.org/licenses/MIT contact: name: Intersight API support url: https://intersight.com/help email: intersight@cisco.com externalDocs: url: /apidocs description: Online documentation for the Intersight APIs servers: - url: 'https://{server}' variables: server: default: intersight.com # SaaS server description: The Intersight URL for the cloud-based infrastructure management APIs. # Because the cookieAuth applies to all paths globally, we can use the security key at the # root level of the OpenAPI document. However, due to limitations in the generated Python SDK, # the cookieAuth is specified on the operation level. #security: # # Apply cookie auth globally to all operations # - cookieAuth: [] tags: - name: aaa - name: access - name: adapter - name: appliance - name: asset - name: bios - name: boot - name: capability - name: cmrf - name: comm - name: compute - name: cond - name: config - name: connector - name: connectorpack - name: content - name: deviceconnector - name: equipment - name: ether - name: externalsite - name: fabric - name: fault - name: fc - name: fcpool - name: feedback - name: firmware - name: forecast - name: graphics - name: hcl - name: hyperflex - name: i18n - name: iaas - name: iam - name: imcconnector - name: infra - name: inventory - name: ipmioverlan - name: ippool - name: kvm - name: license - name: ls - name: macpool - name: management - name: memory - name: meta - name: mo - name: network - name: networkconfig - name: niaapi - name: niatelemetry - name: ntp - name: onprem - name: organization - name: os - name: pci - name: pkix - name: policy - name: policyinventory - name: pool - name: port - name: processor - name: recovery - name: resource - name: sdcard - name: sdwan - name: search - name: security - name: server - name: smtp - name: snmp - name: software - name: softwarerepository - name: sol - name: ssh - name: storage - name: syslog - name: tam - name: task - name: techsupportmanagement - name: terminal - name: top - name: ucsd - name: ucsdconnector - name: uuidpool - name: views - name: virtualization - name: vmedia - name: vnic - name: vrf - name: workflow - name: x509 paths: /api/v1/telemetry/TimeSeries: post: tags: - telemetry summary: Perform a Druid time series aggregation request. operationId: QueryTelemetryTimeSeries description: Endpoint that exposes Druid requests for time series data. This endpoint exposes multiple requests, including Time series, Top N, GroupBy, Scan, Time Boundary, Segment meta-data and datasource meta-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.DruidAggregateRequest' 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: 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. type: string host: description: The host on which this error occurred. May be null. type: string /api/v1/aaa/AuditRecords: get: tags: - aaa summary: Read a 'aaa.AuditRecord' resource. operationId: GetAaaAuditRecordList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Audit Logs - READ.aaa.AuditRecord - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/aaa.AuditRecord.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Audit Logs - READ.aaa.AuditRecord - ROLE.Account Administrator - ROLE.User Access Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/access/Policies: get: tags: - access summary: Read a 'access.Policy' resource. operationId: GetAccessPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.access.Policy - 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 'access.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/access.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - access summary: Create a 'access.Policy' resource. operationId: CreateAccessPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.access.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'access.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/access.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'access.Policy' resource was created as requested. The 'access.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/access.Policy' links: GetAccessPolicyByMoid: operationId: GetAccessPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'access.Policy' 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/access.Policy' links: GetAccessPolicyByMoid: operationId: GetAccessPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/access/Policies/{Moid}: get: tags: - access summary: Read a 'access.Policy' resource. operationId: GetAccessPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.access.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'access.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/access.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAccessPolicyByMoid: operationId: GetAccessPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - access summary: Update a 'access.Policy' resource. operationId: UpdateAccessPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.access.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'access.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/access.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'access.Policy' resource was modified as requested. The 'access.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/access.Policy' links: GetAccessPolicyByMoid: operationId: GetAccessPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'access.Policy' resource is asynchronously being modified 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/access.Policy' links: GetAccessPolicyByMoid: operationId: GetAccessPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - access summary: Update a 'access.Policy' resource. operationId: PatchAccessPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.access.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'access.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/access.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 'access.Policy' resource was patched as requested. The 'access.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/access.Policy' links: GetAccessPolicyByMoid: operationId: GetAccessPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'access.Policy' resource is asynchronously being patched 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/access.Policy' links: GetAccessPolicyByMoid: operationId: GetAccessPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - access summary: Delete a 'access.Policy' resource. operationId: DeleteAccessPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.access.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/ConfigPolicies: get: tags: - adapter summary: Read a 'adapter.ConfigPolicy' resource. operationId: GetAdapterConfigPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.adapter.ConfigPolicy - 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 'adapter.ConfigPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/adapter.ConfigPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - adapter summary: Create a 'adapter.ConfigPolicy' resource. operationId: CreateAdapterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.adapter.ConfigPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'adapter.ConfigPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/adapter.ConfigPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.ConfigPolicy' resource was created as requested. The 'adapter.ConfigPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/adapter.ConfigPolicy' links: GetAdapterConfigPolicyByMoid: operationId: GetAdapterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'adapter.ConfigPolicy' 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/adapter.ConfigPolicy' links: GetAdapterConfigPolicyByMoid: operationId: GetAdapterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/ConfigPolicies/{Moid}: get: tags: - adapter summary: Read a 'adapter.ConfigPolicy' resource. operationId: GetAdapterConfigPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.adapter.ConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'adapter.ConfigPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/adapter.ConfigPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAdapterConfigPolicyByMoid: operationId: GetAdapterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - adapter summary: Update a 'adapter.ConfigPolicy' resource. operationId: UpdateAdapterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.adapter.ConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'adapter.ConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/adapter.ConfigPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.ConfigPolicy' resource was modified as requested. The 'adapter.ConfigPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/adapter.ConfigPolicy' links: GetAdapterConfigPolicyByMoid: operationId: GetAdapterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'adapter.ConfigPolicy' resource is asynchronously being modified 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/adapter.ConfigPolicy' links: GetAdapterConfigPolicyByMoid: operationId: GetAdapterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - adapter summary: Update a 'adapter.ConfigPolicy' resource. operationId: PatchAdapterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.adapter.ConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'adapter.ConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/adapter.ConfigPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.ConfigPolicy' resource was patched as requested. The 'adapter.ConfigPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/adapter.ConfigPolicy' links: GetAdapterConfigPolicyByMoid: operationId: GetAdapterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'adapter.ConfigPolicy' resource is asynchronously being patched 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/adapter.ConfigPolicy' links: GetAdapterConfigPolicyByMoid: operationId: GetAdapterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - adapter summary: Delete a 'adapter.ConfigPolicy' resource. operationId: DeleteAdapterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.adapter.ConfigPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/ExtEthInterfaces: get: tags: - adapter summary: Read a 'adapter.ExtEthInterface' resource. operationId: GetAdapterExtEthInterfaceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.ExtEthInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'adapter.ExtEthInterface' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/adapter.ExtEthInterface.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/ExtEthInterfaces/{Moid}: get: tags: - adapter summary: Read a 'adapter.ExtEthInterface' resource. operationId: GetAdapterExtEthInterfaceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.ExtEthInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'adapter.ExtEthInterface' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/adapter.ExtEthInterface' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAdapterExtEthInterfaceByMoid: operationId: GetAdapterExtEthInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ExtEthInterfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/HostEthInterfaces: get: tags: - adapter summary: Read a 'adapter.HostEthInterface' resource. operationId: GetAdapterHostEthInterfaceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.HostEthInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'adapter.HostEthInterface' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/adapter.HostEthInterface.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/HostEthInterfaces/{Moid}: get: tags: - adapter summary: Read a 'adapter.HostEthInterface' resource. operationId: GetAdapterHostEthInterfaceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.HostEthInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'adapter.HostEthInterface' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/adapter.HostEthInterface' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAdapterHostEthInterfaceByMoid: operationId: GetAdapterHostEthInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostEthInterfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/HostFcInterfaces: get: tags: - adapter summary: Read a 'adapter.HostFcInterface' resource. operationId: GetAdapterHostFcInterfaceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.HostFcInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'adapter.HostFcInterface' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/adapter.HostFcInterface.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/HostFcInterfaces/{Moid}: get: tags: - adapter summary: Read a 'adapter.HostFcInterface' resource. operationId: GetAdapterHostFcInterfaceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.HostFcInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'adapter.HostFcInterface' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/adapter.HostFcInterface' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAdapterHostFcInterfaceByMoid: operationId: GetAdapterHostFcInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostFcInterfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/HostIscsiInterfaces: get: tags: - adapter summary: Read a 'adapter.HostIscsiInterface' resource. operationId: GetAdapterHostIscsiInterfaceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.HostIscsiInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'adapter.HostIscsiInterface' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/adapter.HostIscsiInterface.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/HostIscsiInterfaces/{Moid}: get: tags: - adapter summary: Read a 'adapter.HostIscsiInterface' resource. operationId: GetAdapterHostIscsiInterfaceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.HostIscsiInterface - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'adapter.HostIscsiInterface' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/adapter.HostIscsiInterface' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAdapterHostIscsiInterfaceByMoid: operationId: GetAdapterHostIscsiInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostIscsiInterfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/Units: get: tags: - adapter summary: Read a 'adapter.Unit' resource. operationId: GetAdapterUnitList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'adapter.Unit' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/adapter.Unit.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/adapter/Units/{Moid}: get: tags: - adapter summary: Read a 'adapter.Unit' resource. operationId: GetAdapterUnitByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.adapter.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'adapter.Unit' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/adapter.Unit' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAdapterUnitByMoid: operationId: GetAdapterUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/appliance/Backups: get: tags: - appliance summary: Read a 'appliance.Backup' resource. operationId: GetApplianceBackupList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.Backup parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.Backup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.Backup' 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/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: - READ.appliance.Backup parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/BackupPolicies: get: tags: - appliance summary: Read a 'appliance.BackupPolicy' resource. operationId: GetApplianceBackupPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.BackupPolicy parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.BackupPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.BackupPolicy' 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/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: - READ.appliance.BackupPolicy parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: - UPDATE.appliance.BackupPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'appliance.BackupPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/appliance.BackupPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.BackupPolicy' resource is asynchronously being modified 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/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: - UPDATE.appliance.BackupPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'appliance.BackupPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.BackupPolicy' resource is asynchronously being patched 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/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/CertificateSettings: get: tags: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.CertificateSetting.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/appliance.CertificateSetting' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.CertificateSetting' resource is asynchronously being modified 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/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.CertificateSetting' resource is asynchronously being patched 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/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/DataExportPolicies: get: tags: - appliance summary: Read a 'appliance.DataExportPolicy' resource. operationId: GetApplianceDataExportPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.DataExportPolicy parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.DataExportPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.DataExportPolicy' 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/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: - READ.appliance.DataExportPolicy parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: - UPDATE.appliance.DataExportPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'appliance.DataExportPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/appliance.DataExportPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.DataExportPolicy' resource is asynchronously being modified 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/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: - UPDATE.appliance.DataExportPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'appliance.DataExportPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.DataExportPolicy' resource is asynchronously being patched 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/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/DeviceClaims: get: tags: - appliance summary: Read a 'appliance.DeviceClaim' resource. operationId: GetApplianceDeviceClaimList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Claim Devices - PRIVSET.Read-Only - READ.appliance.DeviceClaim - ROLE.Account Administrator - ROLE.Device Technician - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.DeviceClaim.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.DeviceClaim' resource. operationId: CreateApplianceDeviceClaim security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.appliance.DeviceClaim - PRIVSET.Account Administrator - PRIVSET.Claim Devices - ROLE.Account Administrator - ROLE.Device Technician 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.DeviceClaim' 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/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 summary: Read a 'appliance.DeviceClaim' resource. operationId: GetApplianceDeviceClaimByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Claim Devices - PRIVSET.Read-Only - READ.appliance.DeviceClaim - ROLE.Account Administrator - ROLE.Device Technician - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' /api/v1/appliance/DiagSettings: post: tags: - 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.DiagSetting' 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/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 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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.DiagSetting.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/appliance.DiagSetting' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.DiagSetting' resource is asynchronously being modified 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/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.DiagSetting' resource is asynchronously being patched 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/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 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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/ImageBundles: get: tags: - appliance summary: Read a 'appliance.ImageBundle' resource. operationId: GetApplianceImageBundleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage API Keys - PRIVSET.Read-Only - READ.appliance.ImageBundle - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.ImageBundle.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'appliance.ImageBundle' resource. operationId: GetApplianceImageBundleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage API Keys - PRIVSET.Read-Only - READ.appliance.ImageBundle - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/NodeInfos: get: tags: - appliance summary: Read a 'appliance.NodeInfo' resource. operationId: GetApplianceNodeInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.NodeInfo parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.NodeInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'appliance.NodeInfo' resource. operationId: GetApplianceNodeInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.NodeInfo parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/ReleaseNotes: get: tags: - appliance summary: Read a 'appliance.ReleaseNote' resource. operationId: GetApplianceReleaseNoteList 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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.ReleaseNote.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'appliance.ReleaseNote' resource. operationId: GetApplianceReleaseNoteByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.ReleaseNote parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/Restores: get: tags: - appliance summary: Read a 'appliance.Restore' resource. operationId: GetApplianceRestoreList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.Restore parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.Restore.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.Restore' 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/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: - READ.appliance.Restore parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 summary: Read a 'appliance.SetupInfo' resource. operationId: GetApplianceSetupInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.SetupInfo parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.SetupInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'appliance.SetupInfo' resource. operationId: GetApplianceSetupInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.SetupInfo parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/appliance.SetupInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.SetupInfo' resource is asynchronously being modified 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/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.SetupInfo' resource is asynchronously being patched 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/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 summary: Read a 'appliance.SystemInfo' resource. operationId: GetApplianceSystemInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.SystemInfo parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.SystemInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'appliance.SystemInfo' resource. operationId: GetApplianceSystemInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.SystemInfo parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/Upgrades: get: tags: - appliance summary: Read a 'appliance.Upgrade' resource. operationId: GetApplianceUpgradeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.Upgrade.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'appliance.Upgrade' resource. operationId: GetApplianceUpgradeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.Upgrade parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/appliance.Upgrade' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.Upgrade' resource is asynchronously being modified 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/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.Upgrade' resource is asynchronously being patched 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/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' /api/v1/appliance/UpgradePolicies: get: tags: - appliance summary: Read a 'appliance.UpgradePolicy' resource. operationId: GetApplianceUpgradePolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.UpgradePolicy parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/appliance.UpgradePolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'appliance.UpgradePolicy' resource. operationId: GetApplianceUpgradePolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.appliance.UpgradePolicy parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 summary: Update a 'appliance.UpgradePolicy' resource. operationId: UpdateApplianceUpgradePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/appliance.UpgradePolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.UpgradePolicy' resource is asynchronously being modified 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/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 summary: Update a 'appliance.UpgradePolicy' resource. operationId: PatchApplianceUpgradePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'appliance.UpgradePolicy' resource is asynchronously being patched 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/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/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.View Devices - READ.asset.ClusterMember - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/asset.ClusterMember.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Devices - READ.asset.ClusterMember - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/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 - ROLE.Account Administrator - ROLE.Device Technician 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.DeviceClaim' 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/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 - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: # Response as JSON document. schema: $ref: '#/components/schemas/asset.DeviceConfiguration.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/asset.DeviceConfiguration' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.DeviceConfiguration' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.DeviceConfiguration' resource is asynchronously being patched 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/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.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/asset.DeviceConnectorManager.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.View Devices - PRIVSET.View Servers - READ.asset.DeviceContractInformation - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/asset.DeviceContractInformation.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Devices - PRIVSET.View Servers - READ.asset.DeviceContractInformation - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/asset.DeviceContractInformation' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.DeviceContractInformation' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.DeviceContractInformation' resource is asynchronously being patched 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/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/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.View Devices - PRIVSET.View Servers - READ.asset.DeviceRegistration - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/asset.DeviceRegistration.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Devices - PRIVSET.View Servers - READ.asset.DeviceRegistration - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' delete: tags: - asset summary: Deletes the resource representing the device connector. All associated REST resources will be deleted. In particular, inventory and operational data associated with this device will be deleted. operationId: DeleteAssetDeviceRegistration security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.asset.DeviceRegistration - PRIVSET.Delete Devices 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - 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 - ROLE.Account Administrator - ROLE.Device Technician - UPDATE.asset.DeviceRegistration parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'asset.DeviceRegistration' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/asset.DeviceRegistration' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.DeviceRegistration' resource is asynchronously being modified 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/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 - ROLE.Account Administrator - ROLE.Device Technician - UPDATE.asset.DeviceRegistration parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'asset.DeviceRegistration' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.DeviceRegistration' resource is asynchronously being patched 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/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/ManagedDevices: get: tags: - asset summary: Read a 'asset.ManagedDevice' resource. operationId: GetAssetManagedDeviceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Claim Devices - PRIVSET.Delete Devices - PRIVSET.Read-Only - PRIVSET.View Devices - READ.asset.ManagedDevice - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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.ManagedDevice' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/asset.ManagedDevice.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.ManagedDevice' resource. operationId: CreateAssetManagedDevice security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.asset.ManagedDevice - PRIVSET.Account Administrator - PRIVSET.Claim Devices - ROLE.Account Administrator - ROLE.Device Technician parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'asset.ManagedDevice' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/asset.ManagedDevice' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'asset.ManagedDevice' resource was created as requested. The 'asset.ManagedDevice' 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.ManagedDevice' links: GetAssetManagedDeviceByMoid: operationId: GetAssetManagedDeviceByMoid 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/ManagedDevices/{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 'asset.ManagedDevice' 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/asset.ManagedDevice' links: GetAssetManagedDeviceByMoid: operationId: GetAssetManagedDeviceByMoid 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/ManagedDevices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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/ManagedDevices/{Moid}: get: tags: - asset summary: Read a 'asset.ManagedDevice' resource. operationId: GetAssetManagedDeviceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Claim Devices - PRIVSET.Delete Devices - PRIVSET.Read-Only - PRIVSET.View Devices - READ.asset.ManagedDevice - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'asset.ManagedDevice' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/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.ManagedDevice' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetAssetManagedDeviceByMoid: operationId: GetAssetManagedDeviceByMoid 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/ManagedDevices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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.ManagedDevice' resource. operationId: DeleteAssetManagedDevice security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.asset.ManagedDevice - PRIVSET.Account Administrator - PRIVSET.Delete Devices - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - asset summary: Update a 'asset.ManagedDevice' resource. operationId: UpdateAssetManagedDevice security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Claim Devices - ROLE.Account Administrator - ROLE.Device Technician - UPDATE.asset.ManagedDevice parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'asset.ManagedDevice' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/asset.ManagedDevice' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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.ManagedDevice' resource was modified as requested. The 'asset.ManagedDevice' resource is modified before this response is sent back and the resource is returned in the body of the message. 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.ManagedDevice' links: GetAssetManagedDeviceByMoid: operationId: GetAssetManagedDeviceByMoid 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/ManagedDevices/{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 'asset.ManagedDevice' resource is asynchronously being modified 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/asset.ManagedDevice' links: GetAssetManagedDeviceByMoid: operationId: GetAssetManagedDeviceByMoid 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/ManagedDevices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.ManagedDevice' resource. operationId: PatchAssetManagedDevice security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Claim Devices - ROLE.Account Administrator - ROLE.Device Technician - UPDATE.asset.ManagedDevice parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'asset.ManagedDevice' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/asset.ManagedDevice' application/json-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.ManagedDevice' resource was patched as requested. The 'asset.ManagedDevice' resource is patched before this response is sent back and the resource is returned in the body of the message. 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.ManagedDevice' links: GetAssetManagedDeviceByMoid: operationId: GetAssetManagedDeviceByMoid 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/ManagedDevices/{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 'asset.ManagedDevice' resource is asynchronously being patched 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/asset.ManagedDevice' links: GetAssetManagedDeviceByMoid: operationId: GetAssetManagedDeviceByMoid 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/ManagedDevices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Devices - READ.asset.Target - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/asset.Target.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 - ROLE.Account Administrator - ROLE.Device Technician 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.Target' 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/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.View Devices - READ.asset.Target - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' 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 - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - asset summary: Update a 'asset.Target' resource. operationId: UpdateAssetTarget security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Claim Devices - ROLE.Account Administrator - ROLE.Device Technician - UPDATE.asset.Target parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'asset.Target' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/asset.Target' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.Target' resource is asynchronously being modified 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/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 - ROLE.Account Administrator - ROLE.Device Technician - UPDATE.asset.Target parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'asset.Target' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'asset.Target' resource is asynchronously being patched 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/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/bios/BootDevices: get: tags: - bios summary: Read a 'bios.BootDevice' resource. operationId: GetBiosBootDeviceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.BootDevice - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'bios.BootDevice' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/bios.BootDevice.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/BootDevices/{Moid}: get: tags: - bios summary: Read a 'bios.BootDevice' resource. operationId: GetBiosBootDeviceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.BootDevice - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'bios.BootDevice' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/bios.BootDevice' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetBiosBootDeviceByMoid: operationId: GetBiosBootDeviceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootDevices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/BootModes: get: tags: - bios summary: Read a 'bios.BootMode' resource. operationId: GetBiosBootModeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.BootMode - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'bios.BootMode' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/bios.BootMode.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/BootModes/{Moid}: get: tags: - bios summary: Read a 'bios.BootMode' resource. operationId: GetBiosBootModeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.BootMode - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'bios.BootMode' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/bios.BootMode' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetBiosBootModeByMoid: operationId: GetBiosBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - bios summary: Update a 'bios.BootMode' resource. operationId: UpdateBiosBootMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.bios.BootMode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'bios.BootMode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/bios.BootMode' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'bios.BootMode' resource was modified as requested. The 'bios.BootMode' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/bios.BootMode' links: GetBiosBootModeByMoid: operationId: GetBiosBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'bios.BootMode' resource is asynchronously being modified 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/bios.BootMode' links: GetBiosBootModeByMoid: operationId: GetBiosBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - bios summary: Update a 'bios.BootMode' resource. operationId: PatchBiosBootMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.bios.BootMode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'bios.BootMode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/bios.BootMode' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'bios.BootMode' resource was patched as requested. The 'bios.BootMode' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/bios.BootMode' links: GetBiosBootModeByMoid: operationId: GetBiosBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'bios.BootMode' resource is asynchronously being patched 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/bios.BootMode' links: GetBiosBootModeByMoid: operationId: GetBiosBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/Policies: get: tags: - bios summary: Read a 'bios.Policy' resource. operationId: GetBiosPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.bios.Policy - 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 'bios.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/bios.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - bios summary: Create a 'bios.Policy' resource. operationId: CreateBiosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.bios.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'bios.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/bios.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Policy' resource was created as requested. The 'bios.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/bios.Policy' links: GetBiosPolicyByMoid: operationId: GetBiosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'bios.Policy' 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/bios.Policy' links: GetBiosPolicyByMoid: operationId: GetBiosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/Policies/{Moid}: get: tags: - bios summary: Read a 'bios.Policy' resource. operationId: GetBiosPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.bios.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'bios.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/bios.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetBiosPolicyByMoid: operationId: GetBiosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - bios summary: Update a 'bios.Policy' resource. operationId: UpdateBiosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.bios.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'bios.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/bios.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Policy' resource was modified as requested. The 'bios.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/bios.Policy' links: GetBiosPolicyByMoid: operationId: GetBiosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'bios.Policy' resource is asynchronously being modified 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/bios.Policy' links: GetBiosPolicyByMoid: operationId: GetBiosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - bios summary: Update a 'bios.Policy' resource. operationId: PatchBiosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.bios.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'bios.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/bios.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 'bios.Policy' resource was patched as requested. The 'bios.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/bios.Policy' links: GetBiosPolicyByMoid: operationId: GetBiosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'bios.Policy' resource is asynchronously being patched 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/bios.Policy' links: GetBiosPolicyByMoid: operationId: GetBiosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - bios summary: Delete a 'bios.Policy' resource. operationId: DeleteBiosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.bios.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/SystemBootOrders: get: tags: - bios summary: Read a 'bios.SystemBootOrder' resource. operationId: GetBiosSystemBootOrderList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.SystemBootOrder - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'bios.SystemBootOrder' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/bios.SystemBootOrder.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/SystemBootOrders/{Moid}: get: tags: - bios summary: Read a 'bios.SystemBootOrder' resource. operationId: GetBiosSystemBootOrderByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.SystemBootOrder - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'bios.SystemBootOrder' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/bios.SystemBootOrder' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetBiosSystemBootOrderByMoid: operationId: GetBiosSystemBootOrderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/SystemBootOrders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/Units: get: tags: - bios summary: Read a 'bios.Unit' resource. operationId: GetBiosUnitList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'bios.Unit' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/bios.Unit.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/bios/Units/{Moid}: get: tags: - bios summary: Read a 'bios.Unit' resource. operationId: GetBiosUnitByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.bios.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'bios.Unit' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/bios.Unit' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetBiosUnitByMoid: operationId: GetBiosUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - bios summary: Update a 'bios.Unit' resource. operationId: UpdateBiosUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.bios.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'bios.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/bios.Unit' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Unit' resource was modified as requested. The 'bios.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/bios.Unit' links: GetBiosUnitByMoid: operationId: GetBiosUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'bios.Unit' resource is asynchronously being modified 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/bios.Unit' links: GetBiosUnitByMoid: operationId: GetBiosUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - bios summary: Update a 'bios.Unit' resource. operationId: PatchBiosUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.bios.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'bios.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/bios.Unit' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Unit' resource was patched as requested. The 'bios.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/bios.Unit' links: GetBiosUnitByMoid: operationId: GetBiosUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'bios.Unit' resource is asynchronously being patched 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/bios.Unit' links: GetBiosUnitByMoid: operationId: GetBiosUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/boot/DeviceBootModes: get: tags: - boot summary: Read a 'boot.DeviceBootMode' resource. operationId: GetBootDeviceBootModeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.boot.DeviceBootMode - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'boot.DeviceBootMode' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/boot.DeviceBootMode.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/boot/DeviceBootModes/{Moid}: get: tags: - boot summary: Read a 'boot.DeviceBootMode' resource. operationId: GetBootDeviceBootModeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.boot.DeviceBootMode - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'boot.DeviceBootMode' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/boot.DeviceBootMode' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetBootDeviceBootModeByMoid: operationId: GetBootDeviceBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - boot summary: Update a 'boot.DeviceBootMode' resource. operationId: UpdateBootDeviceBootMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.boot.DeviceBootMode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'boot.DeviceBootMode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/boot.DeviceBootMode' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'boot.DeviceBootMode' resource was modified as requested. The 'boot.DeviceBootMode' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/boot.DeviceBootMode' links: GetBootDeviceBootModeByMoid: operationId: GetBootDeviceBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'boot.DeviceBootMode' resource is asynchronously being modified 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/boot.DeviceBootMode' links: GetBootDeviceBootModeByMoid: operationId: GetBootDeviceBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - boot summary: Update a 'boot.DeviceBootMode' resource. operationId: PatchBootDeviceBootMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.boot.DeviceBootMode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'boot.DeviceBootMode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/boot.DeviceBootMode' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'boot.DeviceBootMode' resource was patched as requested. The 'boot.DeviceBootMode' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/boot.DeviceBootMode' links: GetBootDeviceBootModeByMoid: operationId: GetBootDeviceBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'boot.DeviceBootMode' resource is asynchronously being patched 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/boot.DeviceBootMode' links: GetBootDeviceBootModeByMoid: operationId: GetBootDeviceBootModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/boot/PrecisionPolicies: get: tags: - boot summary: Read a 'boot.PrecisionPolicy' resource. operationId: GetBootPrecisionPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.boot.PrecisionPolicy - 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 'boot.PrecisionPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/boot.PrecisionPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - boot summary: Create a 'boot.PrecisionPolicy' resource. operationId: CreateBootPrecisionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.boot.PrecisionPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'boot.PrecisionPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/boot.PrecisionPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PrecisionPolicy' resource was created as requested. The 'boot.PrecisionPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/boot.PrecisionPolicy' links: GetBootPrecisionPolicyByMoid: operationId: GetBootPrecisionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'boot.PrecisionPolicy' 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/boot.PrecisionPolicy' links: GetBootPrecisionPolicyByMoid: operationId: GetBootPrecisionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/boot/PrecisionPolicies/{Moid}: get: tags: - boot summary: Read a 'boot.PrecisionPolicy' resource. operationId: GetBootPrecisionPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.boot.PrecisionPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'boot.PrecisionPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/boot.PrecisionPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetBootPrecisionPolicyByMoid: operationId: GetBootPrecisionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - boot summary: Update a 'boot.PrecisionPolicy' resource. operationId: UpdateBootPrecisionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.boot.PrecisionPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'boot.PrecisionPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/boot.PrecisionPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PrecisionPolicy' resource was modified as requested. The 'boot.PrecisionPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/boot.PrecisionPolicy' links: GetBootPrecisionPolicyByMoid: operationId: GetBootPrecisionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'boot.PrecisionPolicy' resource is asynchronously being modified 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/boot.PrecisionPolicy' links: GetBootPrecisionPolicyByMoid: operationId: GetBootPrecisionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - boot summary: Update a 'boot.PrecisionPolicy' resource. operationId: PatchBootPrecisionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.boot.PrecisionPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'boot.PrecisionPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/boot.PrecisionPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PrecisionPolicy' resource was patched as requested. The 'boot.PrecisionPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/boot.PrecisionPolicy' links: GetBootPrecisionPolicyByMoid: operationId: GetBootPrecisionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'boot.PrecisionPolicy' resource is asynchronously being patched 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/boot.PrecisionPolicy' links: GetBootPrecisionPolicyByMoid: operationId: GetBootPrecisionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - boot summary: Delete a 'boot.PrecisionPolicy' resource. operationId: DeleteBootPrecisionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.boot.PrecisionPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/AdapterUnitDescriptors: get: tags: - capability summary: Read a 'capability.AdapterUnitDescriptor' resource. operationId: GetCapabilityAdapterUnitDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.AdapterUnitDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.AdapterUnitDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.AdapterUnitDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.AdapterUnitDescriptor' resource. operationId: CreateCapabilityAdapterUnitDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.AdapterUnitDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.AdapterUnitDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.AdapterUnitDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.AdapterUnitDescriptor' resource was created as requested. The 'capability.AdapterUnitDescriptor' 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/capability.AdapterUnitDescriptor' links: GetCapabilityAdapterUnitDescriptorByMoid: operationId: GetCapabilityAdapterUnitDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.AdapterUnitDescriptor' 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/capability.AdapterUnitDescriptor' links: GetCapabilityAdapterUnitDescriptorByMoid: operationId: GetCapabilityAdapterUnitDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/AdapterUnitDescriptors/{Moid}: get: tags: - capability summary: Read a 'capability.AdapterUnitDescriptor' resource. operationId: GetCapabilityAdapterUnitDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.AdapterUnitDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.AdapterUnitDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.AdapterUnitDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityAdapterUnitDescriptorByMoid: operationId: GetCapabilityAdapterUnitDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.AdapterUnitDescriptor' resource. operationId: UpdateCapabilityAdapterUnitDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.AdapterUnitDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.AdapterUnitDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.AdapterUnitDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.AdapterUnitDescriptor' resource was modified as requested. The 'capability.AdapterUnitDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.AdapterUnitDescriptor' links: GetCapabilityAdapterUnitDescriptorByMoid: operationId: GetCapabilityAdapterUnitDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.AdapterUnitDescriptor' resource is asynchronously being modified 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/capability.AdapterUnitDescriptor' links: GetCapabilityAdapterUnitDescriptorByMoid: operationId: GetCapabilityAdapterUnitDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.AdapterUnitDescriptor' resource. operationId: PatchCapabilityAdapterUnitDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.AdapterUnitDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.AdapterUnitDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.AdapterUnitDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.AdapterUnitDescriptor' resource was patched as requested. The 'capability.AdapterUnitDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.AdapterUnitDescriptor' links: GetCapabilityAdapterUnitDescriptorByMoid: operationId: GetCapabilityAdapterUnitDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.AdapterUnitDescriptor' resource is asynchronously being patched 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/capability.AdapterUnitDescriptor' links: GetCapabilityAdapterUnitDescriptorByMoid: operationId: GetCapabilityAdapterUnitDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.AdapterUnitDescriptor' resource. operationId: DeleteCapabilityAdapterUnitDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.AdapterUnitDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/Catalogs: get: tags: - capability summary: Read a 'capability.Catalog' resource. operationId: GetCapabilityCatalogList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.Catalog - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.Catalog' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.Catalog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/Catalogs/{Moid}: get: tags: - capability summary: Read a 'capability.Catalog' resource. operationId: GetCapabilityCatalogByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.Catalog - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.Catalog' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.Catalog' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityCatalogByMoid: operationId: GetCapabilityCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Catalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.Catalog' resource. operationId: UpdateCapabilityCatalog security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.Catalog parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.Catalog' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.Catalog' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.Catalog' resource was modified as requested. The 'capability.Catalog' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.Catalog' links: GetCapabilityCatalogByMoid: operationId: GetCapabilityCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Catalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.Catalog' resource is asynchronously being modified 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/capability.Catalog' links: GetCapabilityCatalogByMoid: operationId: GetCapabilityCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Catalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.Catalog' resource. operationId: PatchCapabilityCatalog security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.Catalog parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.Catalog' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.Catalog' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.Catalog' resource was patched as requested. The 'capability.Catalog' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.Catalog' links: GetCapabilityCatalogByMoid: operationId: GetCapabilityCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Catalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.Catalog' resource is asynchronously being patched 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/capability.Catalog' links: GetCapabilityCatalogByMoid: operationId: GetCapabilityCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Catalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/ChassisDescriptors: get: tags: - capability summary: Read a 'capability.ChassisDescriptor' resource. operationId: GetCapabilityChassisDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.ChassisDescriptor - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.ChassisDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.ChassisDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.ChassisDescriptor' resource. operationId: CreateCapabilityChassisDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.ChassisDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.ChassisDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.ChassisDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.ChassisDescriptor' resource was created as requested. The 'capability.ChassisDescriptor' 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/capability.ChassisDescriptor' links: GetCapabilityChassisDescriptorByMoid: operationId: GetCapabilityChassisDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.ChassisDescriptor' 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/capability.ChassisDescriptor' links: GetCapabilityChassisDescriptorByMoid: operationId: GetCapabilityChassisDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/ChassisDescriptors/{Moid}: get: tags: - capability summary: Read a 'capability.ChassisDescriptor' resource. operationId: GetCapabilityChassisDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.ChassisDescriptor - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.ChassisDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.ChassisDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityChassisDescriptorByMoid: operationId: GetCapabilityChassisDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.ChassisDescriptor' resource. operationId: UpdateCapabilityChassisDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.ChassisDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.ChassisDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.ChassisDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.ChassisDescriptor' resource was modified as requested. The 'capability.ChassisDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.ChassisDescriptor' links: GetCapabilityChassisDescriptorByMoid: operationId: GetCapabilityChassisDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.ChassisDescriptor' resource is asynchronously being modified 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/capability.ChassisDescriptor' links: GetCapabilityChassisDescriptorByMoid: operationId: GetCapabilityChassisDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.ChassisDescriptor' resource. operationId: PatchCapabilityChassisDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.ChassisDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.ChassisDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.ChassisDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.ChassisDescriptor' resource was patched as requested. The 'capability.ChassisDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.ChassisDescriptor' links: GetCapabilityChassisDescriptorByMoid: operationId: GetCapabilityChassisDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.ChassisDescriptor' resource is asynchronously being patched 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/capability.ChassisDescriptor' links: GetCapabilityChassisDescriptorByMoid: operationId: GetCapabilityChassisDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.ChassisDescriptor' resource. operationId: DeleteCapabilityChassisDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.ChassisDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/ChassisManufacturingDefs: get: tags: - capability summary: Read a 'capability.ChassisManufacturingDef' resource. operationId: GetCapabilityChassisManufacturingDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.ChassisManufacturingDef - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.ChassisManufacturingDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.ChassisManufacturingDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.ChassisManufacturingDef' resource. operationId: CreateCapabilityChassisManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.ChassisManufacturingDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.ChassisManufacturingDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.ChassisManufacturingDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.ChassisManufacturingDef' resource was created as requested. The 'capability.ChassisManufacturingDef' 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/capability.ChassisManufacturingDef' links: GetCapabilityChassisManufacturingDefByMoid: operationId: GetCapabilityChassisManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.ChassisManufacturingDef' 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/capability.ChassisManufacturingDef' links: GetCapabilityChassisManufacturingDefByMoid: operationId: GetCapabilityChassisManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/ChassisManufacturingDefs/{Moid}: get: tags: - capability summary: Read a 'capability.ChassisManufacturingDef' resource. operationId: GetCapabilityChassisManufacturingDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.ChassisManufacturingDef - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.ChassisManufacturingDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.ChassisManufacturingDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityChassisManufacturingDefByMoid: operationId: GetCapabilityChassisManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.ChassisManufacturingDef' resource. operationId: UpdateCapabilityChassisManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.ChassisManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.ChassisManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.ChassisManufacturingDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.ChassisManufacturingDef' resource was modified as requested. The 'capability.ChassisManufacturingDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.ChassisManufacturingDef' links: GetCapabilityChassisManufacturingDefByMoid: operationId: GetCapabilityChassisManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.ChassisManufacturingDef' resource is asynchronously being modified 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/capability.ChassisManufacturingDef' links: GetCapabilityChassisManufacturingDefByMoid: operationId: GetCapabilityChassisManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.ChassisManufacturingDef' resource. operationId: PatchCapabilityChassisManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.ChassisManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.ChassisManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.ChassisManufacturingDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.ChassisManufacturingDef' resource was patched as requested. The 'capability.ChassisManufacturingDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.ChassisManufacturingDef' links: GetCapabilityChassisManufacturingDefByMoid: operationId: GetCapabilityChassisManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.ChassisManufacturingDef' resource is asynchronously being patched 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/capability.ChassisManufacturingDef' links: GetCapabilityChassisManufacturingDefByMoid: operationId: GetCapabilityChassisManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.ChassisManufacturingDef' resource. operationId: DeleteCapabilityChassisManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.ChassisManufacturingDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/EquipmentPhysicalDefs: get: tags: - capability summary: Read a 'capability.EquipmentPhysicalDef' resource. operationId: GetCapabilityEquipmentPhysicalDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.EquipmentPhysicalDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.EquipmentPhysicalDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.EquipmentPhysicalDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.EquipmentPhysicalDef' resource. operationId: CreateCapabilityEquipmentPhysicalDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.EquipmentPhysicalDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.EquipmentPhysicalDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentPhysicalDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.EquipmentPhysicalDef' resource was created as requested. The 'capability.EquipmentPhysicalDef' 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/capability.EquipmentPhysicalDef' links: GetCapabilityEquipmentPhysicalDefByMoid: operationId: GetCapabilityEquipmentPhysicalDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.EquipmentPhysicalDef' 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/capability.EquipmentPhysicalDef' links: GetCapabilityEquipmentPhysicalDefByMoid: operationId: GetCapabilityEquipmentPhysicalDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/EquipmentPhysicalDefs/{Moid}: get: tags: - capability summary: Read a 'capability.EquipmentPhysicalDef' resource. operationId: GetCapabilityEquipmentPhysicalDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.EquipmentPhysicalDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.EquipmentPhysicalDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentPhysicalDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityEquipmentPhysicalDefByMoid: operationId: GetCapabilityEquipmentPhysicalDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.EquipmentPhysicalDef' resource. operationId: UpdateCapabilityEquipmentPhysicalDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.EquipmentPhysicalDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.EquipmentPhysicalDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.EquipmentPhysicalDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.EquipmentPhysicalDef' resource was modified as requested. The 'capability.EquipmentPhysicalDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentPhysicalDef' links: GetCapabilityEquipmentPhysicalDefByMoid: operationId: GetCapabilityEquipmentPhysicalDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.EquipmentPhysicalDef' resource is asynchronously being modified 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/capability.EquipmentPhysicalDef' links: GetCapabilityEquipmentPhysicalDefByMoid: operationId: GetCapabilityEquipmentPhysicalDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.EquipmentPhysicalDef' resource. operationId: PatchCapabilityEquipmentPhysicalDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.EquipmentPhysicalDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.EquipmentPhysicalDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.EquipmentPhysicalDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.EquipmentPhysicalDef' resource was patched as requested. The 'capability.EquipmentPhysicalDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentPhysicalDef' links: GetCapabilityEquipmentPhysicalDefByMoid: operationId: GetCapabilityEquipmentPhysicalDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.EquipmentPhysicalDef' resource is asynchronously being patched 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/capability.EquipmentPhysicalDef' links: GetCapabilityEquipmentPhysicalDefByMoid: operationId: GetCapabilityEquipmentPhysicalDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.EquipmentPhysicalDef' resource. operationId: DeleteCapabilityEquipmentPhysicalDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.EquipmentPhysicalDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/EquipmentSlotArrays: get: tags: - capability summary: Read a 'capability.EquipmentSlotArray' resource. operationId: GetCapabilityEquipmentSlotArrayList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.EquipmentSlotArray - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.EquipmentSlotArray' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.EquipmentSlotArray.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.EquipmentSlotArray' resource. operationId: CreateCapabilityEquipmentSlotArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.EquipmentSlotArray parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.EquipmentSlotArray' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentSlotArray' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.EquipmentSlotArray' resource was created as requested. The 'capability.EquipmentSlotArray' 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/capability.EquipmentSlotArray' links: GetCapabilityEquipmentSlotArrayByMoid: operationId: GetCapabilityEquipmentSlotArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.EquipmentSlotArray' 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/capability.EquipmentSlotArray' links: GetCapabilityEquipmentSlotArrayByMoid: operationId: GetCapabilityEquipmentSlotArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/EquipmentSlotArrays/{Moid}: get: tags: - capability summary: Read a 'capability.EquipmentSlotArray' resource. operationId: GetCapabilityEquipmentSlotArrayByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.EquipmentSlotArray - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.EquipmentSlotArray' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentSlotArray' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityEquipmentSlotArrayByMoid: operationId: GetCapabilityEquipmentSlotArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.EquipmentSlotArray' resource. operationId: UpdateCapabilityEquipmentSlotArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.EquipmentSlotArray parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.EquipmentSlotArray' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.EquipmentSlotArray' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.EquipmentSlotArray' resource was modified as requested. The 'capability.EquipmentSlotArray' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentSlotArray' links: GetCapabilityEquipmentSlotArrayByMoid: operationId: GetCapabilityEquipmentSlotArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.EquipmentSlotArray' resource is asynchronously being modified 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/capability.EquipmentSlotArray' links: GetCapabilityEquipmentSlotArrayByMoid: operationId: GetCapabilityEquipmentSlotArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.EquipmentSlotArray' resource. operationId: PatchCapabilityEquipmentSlotArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.EquipmentSlotArray parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.EquipmentSlotArray' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.EquipmentSlotArray' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.EquipmentSlotArray' resource was patched as requested. The 'capability.EquipmentSlotArray' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.EquipmentSlotArray' links: GetCapabilityEquipmentSlotArrayByMoid: operationId: GetCapabilityEquipmentSlotArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.EquipmentSlotArray' resource is asynchronously being patched 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/capability.EquipmentSlotArray' links: GetCapabilityEquipmentSlotArrayByMoid: operationId: GetCapabilityEquipmentSlotArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.EquipmentSlotArray' resource. operationId: DeleteCapabilityEquipmentSlotArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.EquipmentSlotArray 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/FanModuleDescriptors: get: tags: - capability summary: Read a 'capability.FanModuleDescriptor' resource. operationId: GetCapabilityFanModuleDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.FanModuleDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.FanModuleDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.FanModuleDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.FanModuleDescriptor' resource. operationId: CreateCapabilityFanModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.FanModuleDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.FanModuleDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.FanModuleDescriptor' resource was created as requested. The 'capability.FanModuleDescriptor' 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/capability.FanModuleDescriptor' links: GetCapabilityFanModuleDescriptorByMoid: operationId: GetCapabilityFanModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.FanModuleDescriptor' 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/capability.FanModuleDescriptor' links: GetCapabilityFanModuleDescriptorByMoid: operationId: GetCapabilityFanModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/FanModuleDescriptors/{Moid}: get: tags: - capability summary: Read a 'capability.FanModuleDescriptor' resource. operationId: GetCapabilityFanModuleDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.FanModuleDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.FanModuleDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityFanModuleDescriptorByMoid: operationId: GetCapabilityFanModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.FanModuleDescriptor' resource. operationId: UpdateCapabilityFanModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.FanModuleDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.FanModuleDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.FanModuleDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.FanModuleDescriptor' resource was modified as requested. The 'capability.FanModuleDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleDescriptor' links: GetCapabilityFanModuleDescriptorByMoid: operationId: GetCapabilityFanModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.FanModuleDescriptor' resource is asynchronously being modified 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/capability.FanModuleDescriptor' links: GetCapabilityFanModuleDescriptorByMoid: operationId: GetCapabilityFanModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.FanModuleDescriptor' resource. operationId: PatchCapabilityFanModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.FanModuleDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.FanModuleDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.FanModuleDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.FanModuleDescriptor' resource was patched as requested. The 'capability.FanModuleDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleDescriptor' links: GetCapabilityFanModuleDescriptorByMoid: operationId: GetCapabilityFanModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.FanModuleDescriptor' resource is asynchronously being patched 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/capability.FanModuleDescriptor' links: GetCapabilityFanModuleDescriptorByMoid: operationId: GetCapabilityFanModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.FanModuleDescriptor' resource. operationId: DeleteCapabilityFanModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.FanModuleDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/FanModuleManufacturingDefs: get: tags: - capability summary: Read a 'capability.FanModuleManufacturingDef' resource. operationId: GetCapabilityFanModuleManufacturingDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.FanModuleManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.FanModuleManufacturingDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.FanModuleManufacturingDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.FanModuleManufacturingDef' resource. operationId: CreateCapabilityFanModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.FanModuleManufacturingDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.FanModuleManufacturingDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleManufacturingDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.FanModuleManufacturingDef' resource was created as requested. The 'capability.FanModuleManufacturingDef' 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/capability.FanModuleManufacturingDef' links: GetCapabilityFanModuleManufacturingDefByMoid: operationId: GetCapabilityFanModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.FanModuleManufacturingDef' 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/capability.FanModuleManufacturingDef' links: GetCapabilityFanModuleManufacturingDefByMoid: operationId: GetCapabilityFanModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/FanModuleManufacturingDefs/{Moid}: get: tags: - capability summary: Read a 'capability.FanModuleManufacturingDef' resource. operationId: GetCapabilityFanModuleManufacturingDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.FanModuleManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.FanModuleManufacturingDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleManufacturingDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityFanModuleManufacturingDefByMoid: operationId: GetCapabilityFanModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.FanModuleManufacturingDef' resource. operationId: UpdateCapabilityFanModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.FanModuleManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.FanModuleManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.FanModuleManufacturingDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.FanModuleManufacturingDef' resource was modified as requested. The 'capability.FanModuleManufacturingDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleManufacturingDef' links: GetCapabilityFanModuleManufacturingDefByMoid: operationId: GetCapabilityFanModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.FanModuleManufacturingDef' resource is asynchronously being modified 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/capability.FanModuleManufacturingDef' links: GetCapabilityFanModuleManufacturingDefByMoid: operationId: GetCapabilityFanModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.FanModuleManufacturingDef' resource. operationId: PatchCapabilityFanModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.FanModuleManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.FanModuleManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.FanModuleManufacturingDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.FanModuleManufacturingDef' resource was patched as requested. The 'capability.FanModuleManufacturingDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.FanModuleManufacturingDef' links: GetCapabilityFanModuleManufacturingDefByMoid: operationId: GetCapabilityFanModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.FanModuleManufacturingDef' resource is asynchronously being patched 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/capability.FanModuleManufacturingDef' links: GetCapabilityFanModuleManufacturingDefByMoid: operationId: GetCapabilityFanModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.FanModuleManufacturingDef' resource. operationId: DeleteCapabilityFanModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.FanModuleManufacturingDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/IoCardCapabilityDefs: get: tags: - capability summary: Read a 'capability.IoCardCapabilityDef' resource. operationId: GetCapabilityIoCardCapabilityDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.IoCardCapabilityDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.IoCardCapabilityDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.IoCardCapabilityDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.IoCardCapabilityDef' resource. operationId: CreateCapabilityIoCardCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.IoCardCapabilityDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.IoCardCapabilityDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.IoCardCapabilityDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardCapabilityDef' resource was created as requested. The 'capability.IoCardCapabilityDef' 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/capability.IoCardCapabilityDef' links: GetCapabilityIoCardCapabilityDefByMoid: operationId: GetCapabilityIoCardCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardCapabilityDef' 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/capability.IoCardCapabilityDef' links: GetCapabilityIoCardCapabilityDefByMoid: operationId: GetCapabilityIoCardCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/IoCardCapabilityDefs/{Moid}: get: tags: - capability summary: Read a 'capability.IoCardCapabilityDef' resource. operationId: GetCapabilityIoCardCapabilityDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.IoCardCapabilityDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.IoCardCapabilityDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardCapabilityDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityIoCardCapabilityDefByMoid: operationId: GetCapabilityIoCardCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.IoCardCapabilityDef' resource. operationId: UpdateCapabilityIoCardCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.IoCardCapabilityDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.IoCardCapabilityDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.IoCardCapabilityDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardCapabilityDef' resource was modified as requested. The 'capability.IoCardCapabilityDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardCapabilityDef' links: GetCapabilityIoCardCapabilityDefByMoid: operationId: GetCapabilityIoCardCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardCapabilityDef' resource is asynchronously being modified 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/capability.IoCardCapabilityDef' links: GetCapabilityIoCardCapabilityDefByMoid: operationId: GetCapabilityIoCardCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.IoCardCapabilityDef' resource. operationId: PatchCapabilityIoCardCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.IoCardCapabilityDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.IoCardCapabilityDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.IoCardCapabilityDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardCapabilityDef' resource was patched as requested. The 'capability.IoCardCapabilityDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardCapabilityDef' links: GetCapabilityIoCardCapabilityDefByMoid: operationId: GetCapabilityIoCardCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardCapabilityDef' resource is asynchronously being patched 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/capability.IoCardCapabilityDef' links: GetCapabilityIoCardCapabilityDefByMoid: operationId: GetCapabilityIoCardCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.IoCardCapabilityDef' resource. operationId: DeleteCapabilityIoCardCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.IoCardCapabilityDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/IoCardDescriptors: get: tags: - capability summary: Read a 'capability.IoCardDescriptor' resource. operationId: GetCapabilityIoCardDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.IoCardDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.IoCardDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.IoCardDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.IoCardDescriptor' resource. operationId: CreateCapabilityIoCardDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.IoCardDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.IoCardDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.IoCardDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardDescriptor' resource was created as requested. The 'capability.IoCardDescriptor' 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/capability.IoCardDescriptor' links: GetCapabilityIoCardDescriptorByMoid: operationId: GetCapabilityIoCardDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardDescriptor' 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/capability.IoCardDescriptor' links: GetCapabilityIoCardDescriptorByMoid: operationId: GetCapabilityIoCardDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/IoCardDescriptors/{Moid}: get: tags: - capability summary: Read a 'capability.IoCardDescriptor' resource. operationId: GetCapabilityIoCardDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.IoCardDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.IoCardDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityIoCardDescriptorByMoid: operationId: GetCapabilityIoCardDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.IoCardDescriptor' resource. operationId: UpdateCapabilityIoCardDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.IoCardDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.IoCardDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.IoCardDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardDescriptor' resource was modified as requested. The 'capability.IoCardDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardDescriptor' links: GetCapabilityIoCardDescriptorByMoid: operationId: GetCapabilityIoCardDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardDescriptor' resource is asynchronously being modified 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/capability.IoCardDescriptor' links: GetCapabilityIoCardDescriptorByMoid: operationId: GetCapabilityIoCardDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.IoCardDescriptor' resource. operationId: PatchCapabilityIoCardDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.IoCardDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.IoCardDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.IoCardDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardDescriptor' resource was patched as requested. The 'capability.IoCardDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardDescriptor' links: GetCapabilityIoCardDescriptorByMoid: operationId: GetCapabilityIoCardDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardDescriptor' resource is asynchronously being patched 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/capability.IoCardDescriptor' links: GetCapabilityIoCardDescriptorByMoid: operationId: GetCapabilityIoCardDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.IoCardDescriptor' resource. operationId: DeleteCapabilityIoCardDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.IoCardDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/IoCardManufacturingDefs: get: tags: - capability summary: Read a 'capability.IoCardManufacturingDef' resource. operationId: GetCapabilityIoCardManufacturingDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.IoCardManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.IoCardManufacturingDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.IoCardManufacturingDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.IoCardManufacturingDef' resource. operationId: CreateCapabilityIoCardManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.IoCardManufacturingDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.IoCardManufacturingDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.IoCardManufacturingDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardManufacturingDef' resource was created as requested. The 'capability.IoCardManufacturingDef' 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/capability.IoCardManufacturingDef' links: GetCapabilityIoCardManufacturingDefByMoid: operationId: GetCapabilityIoCardManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardManufacturingDef' 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/capability.IoCardManufacturingDef' links: GetCapabilityIoCardManufacturingDefByMoid: operationId: GetCapabilityIoCardManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/IoCardManufacturingDefs/{Moid}: get: tags: - capability summary: Read a 'capability.IoCardManufacturingDef' resource. operationId: GetCapabilityIoCardManufacturingDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.IoCardManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.IoCardManufacturingDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardManufacturingDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityIoCardManufacturingDefByMoid: operationId: GetCapabilityIoCardManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.IoCardManufacturingDef' resource. operationId: UpdateCapabilityIoCardManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.IoCardManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.IoCardManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.IoCardManufacturingDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardManufacturingDef' resource was modified as requested. The 'capability.IoCardManufacturingDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardManufacturingDef' links: GetCapabilityIoCardManufacturingDefByMoid: operationId: GetCapabilityIoCardManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardManufacturingDef' resource is asynchronously being modified 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/capability.IoCardManufacturingDef' links: GetCapabilityIoCardManufacturingDefByMoid: operationId: GetCapabilityIoCardManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.IoCardManufacturingDef' resource. operationId: PatchCapabilityIoCardManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.IoCardManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.IoCardManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.IoCardManufacturingDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.IoCardManufacturingDef' resource was patched as requested. The 'capability.IoCardManufacturingDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.IoCardManufacturingDef' links: GetCapabilityIoCardManufacturingDefByMoid: operationId: GetCapabilityIoCardManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.IoCardManufacturingDef' resource is asynchronously being patched 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/capability.IoCardManufacturingDef' links: GetCapabilityIoCardManufacturingDefByMoid: operationId: GetCapabilityIoCardManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.IoCardManufacturingDef' resource. operationId: DeleteCapabilityIoCardManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.IoCardManufacturingDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/PortGroupAggregationDefs: get: tags: - capability summary: Read a 'capability.PortGroupAggregationDef' resource. operationId: GetCapabilityPortGroupAggregationDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.PortGroupAggregationDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.PortGroupAggregationDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.PortGroupAggregationDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.PortGroupAggregationDef' resource. operationId: CreateCapabilityPortGroupAggregationDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.PortGroupAggregationDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.PortGroupAggregationDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.PortGroupAggregationDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PortGroupAggregationDef' resource was created as requested. The 'capability.PortGroupAggregationDef' 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/capability.PortGroupAggregationDef' links: GetCapabilityPortGroupAggregationDefByMoid: operationId: GetCapabilityPortGroupAggregationDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PortGroupAggregationDef' 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/capability.PortGroupAggregationDef' links: GetCapabilityPortGroupAggregationDefByMoid: operationId: GetCapabilityPortGroupAggregationDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/PortGroupAggregationDefs/{Moid}: get: tags: - capability summary: Read a 'capability.PortGroupAggregationDef' resource. operationId: GetCapabilityPortGroupAggregationDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.PortGroupAggregationDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.PortGroupAggregationDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.PortGroupAggregationDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityPortGroupAggregationDefByMoid: operationId: GetCapabilityPortGroupAggregationDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.PortGroupAggregationDef' resource. operationId: UpdateCapabilityPortGroupAggregationDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.PortGroupAggregationDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.PortGroupAggregationDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.PortGroupAggregationDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PortGroupAggregationDef' resource was modified as requested. The 'capability.PortGroupAggregationDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.PortGroupAggregationDef' links: GetCapabilityPortGroupAggregationDefByMoid: operationId: GetCapabilityPortGroupAggregationDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PortGroupAggregationDef' resource is asynchronously being modified 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/capability.PortGroupAggregationDef' links: GetCapabilityPortGroupAggregationDefByMoid: operationId: GetCapabilityPortGroupAggregationDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.PortGroupAggregationDef' resource. operationId: PatchCapabilityPortGroupAggregationDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.PortGroupAggregationDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.PortGroupAggregationDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.PortGroupAggregationDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PortGroupAggregationDef' resource was patched as requested. The 'capability.PortGroupAggregationDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.PortGroupAggregationDef' links: GetCapabilityPortGroupAggregationDefByMoid: operationId: GetCapabilityPortGroupAggregationDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PortGroupAggregationDef' resource is asynchronously being patched 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/capability.PortGroupAggregationDef' links: GetCapabilityPortGroupAggregationDefByMoid: operationId: GetCapabilityPortGroupAggregationDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.PortGroupAggregationDef' resource. operationId: DeleteCapabilityPortGroupAggregationDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.PortGroupAggregationDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/PsuDescriptors: get: tags: - capability summary: Read a 'capability.PsuDescriptor' resource. operationId: GetCapabilityPsuDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.PsuDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.PsuDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.PsuDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.PsuDescriptor' resource. operationId: CreateCapabilityPsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.PsuDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.PsuDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.PsuDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PsuDescriptor' resource was created as requested. The 'capability.PsuDescriptor' 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/capability.PsuDescriptor' links: GetCapabilityPsuDescriptorByMoid: operationId: GetCapabilityPsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PsuDescriptor' 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/capability.PsuDescriptor' links: GetCapabilityPsuDescriptorByMoid: operationId: GetCapabilityPsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/PsuDescriptors/{Moid}: get: tags: - capability summary: Read a 'capability.PsuDescriptor' resource. operationId: GetCapabilityPsuDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.PsuDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.PsuDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.PsuDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityPsuDescriptorByMoid: operationId: GetCapabilityPsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.PsuDescriptor' resource. operationId: UpdateCapabilityPsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.PsuDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.PsuDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.PsuDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PsuDescriptor' resource was modified as requested. The 'capability.PsuDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.PsuDescriptor' links: GetCapabilityPsuDescriptorByMoid: operationId: GetCapabilityPsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PsuDescriptor' resource is asynchronously being modified 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/capability.PsuDescriptor' links: GetCapabilityPsuDescriptorByMoid: operationId: GetCapabilityPsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.PsuDescriptor' resource. operationId: PatchCapabilityPsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.PsuDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.PsuDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.PsuDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PsuDescriptor' resource was patched as requested. The 'capability.PsuDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.PsuDescriptor' links: GetCapabilityPsuDescriptorByMoid: operationId: GetCapabilityPsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PsuDescriptor' resource is asynchronously being patched 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/capability.PsuDescriptor' links: GetCapabilityPsuDescriptorByMoid: operationId: GetCapabilityPsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.PsuDescriptor' resource. operationId: DeleteCapabilityPsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.PsuDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/PsuManufacturingDefs: get: tags: - capability summary: Read a 'capability.PsuManufacturingDef' resource. operationId: GetCapabilityPsuManufacturingDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.PsuManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.PsuManufacturingDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.PsuManufacturingDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.PsuManufacturingDef' resource. operationId: CreateCapabilityPsuManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.PsuManufacturingDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.PsuManufacturingDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.PsuManufacturingDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PsuManufacturingDef' resource was created as requested. The 'capability.PsuManufacturingDef' 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/capability.PsuManufacturingDef' links: GetCapabilityPsuManufacturingDefByMoid: operationId: GetCapabilityPsuManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PsuManufacturingDef' 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/capability.PsuManufacturingDef' links: GetCapabilityPsuManufacturingDefByMoid: operationId: GetCapabilityPsuManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/PsuManufacturingDefs/{Moid}: get: tags: - capability summary: Read a 'capability.PsuManufacturingDef' resource. operationId: GetCapabilityPsuManufacturingDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.PsuManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.PsuManufacturingDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.PsuManufacturingDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilityPsuManufacturingDefByMoid: operationId: GetCapabilityPsuManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.PsuManufacturingDef' resource. operationId: UpdateCapabilityPsuManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.PsuManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.PsuManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.PsuManufacturingDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PsuManufacturingDef' resource was modified as requested. The 'capability.PsuManufacturingDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.PsuManufacturingDef' links: GetCapabilityPsuManufacturingDefByMoid: operationId: GetCapabilityPsuManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PsuManufacturingDef' resource is asynchronously being modified 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/capability.PsuManufacturingDef' links: GetCapabilityPsuManufacturingDefByMoid: operationId: GetCapabilityPsuManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.PsuManufacturingDef' resource. operationId: PatchCapabilityPsuManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.PsuManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.PsuManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.PsuManufacturingDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.PsuManufacturingDef' resource was patched as requested. The 'capability.PsuManufacturingDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.PsuManufacturingDef' links: GetCapabilityPsuManufacturingDefByMoid: operationId: GetCapabilityPsuManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.PsuManufacturingDef' resource is asynchronously being patched 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/capability.PsuManufacturingDef' links: GetCapabilityPsuManufacturingDefByMoid: operationId: GetCapabilityPsuManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.PsuManufacturingDef' resource. operationId: DeleteCapabilityPsuManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.PsuManufacturingDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/Sections: get: tags: - capability summary: Read a 'capability.Section' resource. operationId: GetCapabilitySectionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.Section - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.Section' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.Section.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.Section' resource. operationId: CreateCapabilitySection security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.Section parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.Section' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.Section' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.Section' resource was created as requested. The 'capability.Section' 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/capability.Section' links: GetCapabilitySectionByMoid: operationId: GetCapabilitySectionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Sections/{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 'capability.Section' 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/capability.Section' links: GetCapabilitySectionByMoid: operationId: GetCapabilitySectionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Sections/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/Sections/{Moid}: get: tags: - capability summary: Read a 'capability.Section' resource. operationId: GetCapabilitySectionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.Section - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.Section' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.Section' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilitySectionByMoid: operationId: GetCapabilitySectionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Sections/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.Section' resource. operationId: UpdateCapabilitySection security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.Section parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.Section' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.Section' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.Section' resource was modified as requested. The 'capability.Section' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.Section' links: GetCapabilitySectionByMoid: operationId: GetCapabilitySectionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Sections/{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 'capability.Section' resource is asynchronously being modified 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/capability.Section' links: GetCapabilitySectionByMoid: operationId: GetCapabilitySectionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Sections/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.Section' resource. operationId: PatchCapabilitySection security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.Section parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.Section' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.Section' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.Section' resource was patched as requested. The 'capability.Section' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.Section' links: GetCapabilitySectionByMoid: operationId: GetCapabilitySectionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Sections/{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 'capability.Section' resource is asynchronously being patched 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/capability.Section' links: GetCapabilitySectionByMoid: operationId: GetCapabilitySectionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Sections/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/SiocModuleCapabilityDefs: get: tags: - capability summary: Read a 'capability.SiocModuleCapabilityDef' resource. operationId: GetCapabilitySiocModuleCapabilityDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.SiocModuleCapabilityDef - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.SiocModuleCapabilityDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.SiocModuleCapabilityDef' resource. operationId: CreateCapabilitySiocModuleCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.SiocModuleCapabilityDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.SiocModuleCapabilityDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleCapabilityDef' resource was created as requested. The 'capability.SiocModuleCapabilityDef' 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/capability.SiocModuleCapabilityDef' links: GetCapabilitySiocModuleCapabilityDefByMoid: operationId: GetCapabilitySiocModuleCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleCapabilityDef' 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/capability.SiocModuleCapabilityDef' links: GetCapabilitySiocModuleCapabilityDefByMoid: operationId: GetCapabilitySiocModuleCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/SiocModuleCapabilityDefs/{Moid}: get: tags: - capability summary: Read a 'capability.SiocModuleCapabilityDef' resource. operationId: GetCapabilitySiocModuleCapabilityDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.SiocModuleCapabilityDef - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.SiocModuleCapabilityDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilitySiocModuleCapabilityDefByMoid: operationId: GetCapabilitySiocModuleCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.SiocModuleCapabilityDef' resource. operationId: UpdateCapabilitySiocModuleCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SiocModuleCapabilityDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SiocModuleCapabilityDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleCapabilityDef' resource was modified as requested. The 'capability.SiocModuleCapabilityDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef' links: GetCapabilitySiocModuleCapabilityDefByMoid: operationId: GetCapabilitySiocModuleCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleCapabilityDef' resource is asynchronously being modified 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/capability.SiocModuleCapabilityDef' links: GetCapabilitySiocModuleCapabilityDefByMoid: operationId: GetCapabilitySiocModuleCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.SiocModuleCapabilityDef' resource. operationId: PatchCapabilitySiocModuleCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SiocModuleCapabilityDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SiocModuleCapabilityDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleCapabilityDef' resource was patched as requested. The 'capability.SiocModuleCapabilityDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef' links: GetCapabilitySiocModuleCapabilityDefByMoid: operationId: GetCapabilitySiocModuleCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleCapabilityDef' resource is asynchronously being patched 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/capability.SiocModuleCapabilityDef' links: GetCapabilitySiocModuleCapabilityDefByMoid: operationId: GetCapabilitySiocModuleCapabilityDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.SiocModuleCapabilityDef' resource. operationId: DeleteCapabilitySiocModuleCapabilityDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.SiocModuleCapabilityDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/SiocModuleDescriptors: get: tags: - capability summary: Read a 'capability.SiocModuleDescriptor' resource. operationId: GetCapabilitySiocModuleDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.SiocModuleDescriptor - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.SiocModuleDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.SiocModuleDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.SiocModuleDescriptor' resource. operationId: CreateCapabilitySiocModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.SiocModuleDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.SiocModuleDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleDescriptor' resource was created as requested. The 'capability.SiocModuleDescriptor' 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/capability.SiocModuleDescriptor' links: GetCapabilitySiocModuleDescriptorByMoid: operationId: GetCapabilitySiocModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleDescriptor' 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/capability.SiocModuleDescriptor' links: GetCapabilitySiocModuleDescriptorByMoid: operationId: GetCapabilitySiocModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/SiocModuleDescriptors/{Moid}: get: tags: - capability summary: Read a 'capability.SiocModuleDescriptor' resource. operationId: GetCapabilitySiocModuleDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.SiocModuleDescriptor - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.SiocModuleDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilitySiocModuleDescriptorByMoid: operationId: GetCapabilitySiocModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.SiocModuleDescriptor' resource. operationId: UpdateCapabilitySiocModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SiocModuleDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SiocModuleDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SiocModuleDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleDescriptor' resource was modified as requested. The 'capability.SiocModuleDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleDescriptor' links: GetCapabilitySiocModuleDescriptorByMoid: operationId: GetCapabilitySiocModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleDescriptor' resource is asynchronously being modified 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/capability.SiocModuleDescriptor' links: GetCapabilitySiocModuleDescriptorByMoid: operationId: GetCapabilitySiocModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.SiocModuleDescriptor' resource. operationId: PatchCapabilitySiocModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SiocModuleDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SiocModuleDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SiocModuleDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleDescriptor' resource was patched as requested. The 'capability.SiocModuleDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleDescriptor' links: GetCapabilitySiocModuleDescriptorByMoid: operationId: GetCapabilitySiocModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleDescriptor' resource is asynchronously being patched 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/capability.SiocModuleDescriptor' links: GetCapabilitySiocModuleDescriptorByMoid: operationId: GetCapabilitySiocModuleDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.SiocModuleDescriptor' resource. operationId: DeleteCapabilitySiocModuleDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.SiocModuleDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/SiocModuleManufacturingDefs: get: tags: - capability summary: Read a 'capability.SiocModuleManufacturingDef' resource. operationId: GetCapabilitySiocModuleManufacturingDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.SiocModuleManufacturingDef - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.SiocModuleManufacturingDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.SiocModuleManufacturingDef' resource. operationId: CreateCapabilitySiocModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.SiocModuleManufacturingDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.SiocModuleManufacturingDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleManufacturingDef' resource was created as requested. The 'capability.SiocModuleManufacturingDef' 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/capability.SiocModuleManufacturingDef' links: GetCapabilitySiocModuleManufacturingDefByMoid: operationId: GetCapabilitySiocModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleManufacturingDef' 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/capability.SiocModuleManufacturingDef' links: GetCapabilitySiocModuleManufacturingDefByMoid: operationId: GetCapabilitySiocModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/SiocModuleManufacturingDefs/{Moid}: get: tags: - capability summary: Read a 'capability.SiocModuleManufacturingDef' resource. operationId: GetCapabilitySiocModuleManufacturingDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.capability.SiocModuleManufacturingDef - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.SiocModuleManufacturingDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilitySiocModuleManufacturingDefByMoid: operationId: GetCapabilitySiocModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.SiocModuleManufacturingDef' resource. operationId: UpdateCapabilitySiocModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SiocModuleManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SiocModuleManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleManufacturingDef' resource was modified as requested. The 'capability.SiocModuleManufacturingDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef' links: GetCapabilitySiocModuleManufacturingDefByMoid: operationId: GetCapabilitySiocModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleManufacturingDef' resource is asynchronously being modified 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/capability.SiocModuleManufacturingDef' links: GetCapabilitySiocModuleManufacturingDefByMoid: operationId: GetCapabilitySiocModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.SiocModuleManufacturingDef' resource. operationId: PatchCapabilitySiocModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SiocModuleManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SiocModuleManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SiocModuleManufacturingDef' resource was patched as requested. The 'capability.SiocModuleManufacturingDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef' links: GetCapabilitySiocModuleManufacturingDefByMoid: operationId: GetCapabilitySiocModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SiocModuleManufacturingDef' resource is asynchronously being patched 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/capability.SiocModuleManufacturingDef' links: GetCapabilitySiocModuleManufacturingDefByMoid: operationId: GetCapabilitySiocModuleManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.SiocModuleManufacturingDef' resource. operationId: DeleteCapabilitySiocModuleManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.SiocModuleManufacturingDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/SwitchCapabilities: get: tags: - capability summary: Read a 'capability.SwitchCapability' resource. operationId: GetCapabilitySwitchCapabilityList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.SwitchCapability - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.SwitchCapability' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.SwitchCapability.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.SwitchCapability' resource. operationId: CreateCapabilitySwitchCapability security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.SwitchCapability parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.SwitchCapability' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.SwitchCapability' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchCapability' resource was created as requested. The 'capability.SwitchCapability' 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/capability.SwitchCapability' links: GetCapabilitySwitchCapabilityByMoid: operationId: GetCapabilitySwitchCapabilityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchCapability' 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/capability.SwitchCapability' links: GetCapabilitySwitchCapabilityByMoid: operationId: GetCapabilitySwitchCapabilityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/SwitchCapabilities/{Moid}: get: tags: - capability summary: Read a 'capability.SwitchCapability' resource. operationId: GetCapabilitySwitchCapabilityByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.SwitchCapability - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.SwitchCapability' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchCapability' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilitySwitchCapabilityByMoid: operationId: GetCapabilitySwitchCapabilityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.SwitchCapability' resource. operationId: UpdateCapabilitySwitchCapability security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SwitchCapability parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SwitchCapability' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SwitchCapability' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchCapability' resource was modified as requested. The 'capability.SwitchCapability' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchCapability' links: GetCapabilitySwitchCapabilityByMoid: operationId: GetCapabilitySwitchCapabilityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchCapability' resource is asynchronously being modified 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/capability.SwitchCapability' links: GetCapabilitySwitchCapabilityByMoid: operationId: GetCapabilitySwitchCapabilityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.SwitchCapability' resource. operationId: PatchCapabilitySwitchCapability security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SwitchCapability parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SwitchCapability' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SwitchCapability' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchCapability' resource was patched as requested. The 'capability.SwitchCapability' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchCapability' links: GetCapabilitySwitchCapabilityByMoid: operationId: GetCapabilitySwitchCapabilityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchCapability' resource is asynchronously being patched 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/capability.SwitchCapability' links: GetCapabilitySwitchCapabilityByMoid: operationId: GetCapabilitySwitchCapabilityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.SwitchCapability' resource. operationId: DeleteCapabilitySwitchCapability security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.SwitchCapability 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/SwitchDescriptors: get: tags: - capability summary: Read a 'capability.SwitchDescriptor' resource. operationId: GetCapabilitySwitchDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.SwitchDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.SwitchDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.SwitchDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.SwitchDescriptor' resource. operationId: CreateCapabilitySwitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.SwitchDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.SwitchDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.SwitchDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchDescriptor' resource was created as requested. The 'capability.SwitchDescriptor' 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/capability.SwitchDescriptor' links: GetCapabilitySwitchDescriptorByMoid: operationId: GetCapabilitySwitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchDescriptor' 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/capability.SwitchDescriptor' links: GetCapabilitySwitchDescriptorByMoid: operationId: GetCapabilitySwitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/SwitchDescriptors/{Moid}: get: tags: - capability summary: Read a 'capability.SwitchDescriptor' resource. operationId: GetCapabilitySwitchDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.SwitchDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.SwitchDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilitySwitchDescriptorByMoid: operationId: GetCapabilitySwitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.SwitchDescriptor' resource. operationId: UpdateCapabilitySwitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SwitchDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SwitchDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SwitchDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchDescriptor' resource was modified as requested. The 'capability.SwitchDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchDescriptor' links: GetCapabilitySwitchDescriptorByMoid: operationId: GetCapabilitySwitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchDescriptor' resource is asynchronously being modified 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/capability.SwitchDescriptor' links: GetCapabilitySwitchDescriptorByMoid: operationId: GetCapabilitySwitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.SwitchDescriptor' resource. operationId: PatchCapabilitySwitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SwitchDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SwitchDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SwitchDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchDescriptor' resource was patched as requested. The 'capability.SwitchDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchDescriptor' links: GetCapabilitySwitchDescriptorByMoid: operationId: GetCapabilitySwitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchDescriptor' resource is asynchronously being patched 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/capability.SwitchDescriptor' links: GetCapabilitySwitchDescriptorByMoid: operationId: GetCapabilitySwitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.SwitchDescriptor' resource. operationId: DeleteCapabilitySwitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.SwitchDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/capability/SwitchManufacturingDefs: get: tags: - capability summary: Read a 'capability.SwitchManufacturingDef' resource. operationId: GetCapabilitySwitchManufacturingDefList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.SwitchManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'capability.SwitchManufacturingDef' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/capability.SwitchManufacturingDef.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Create a 'capability.SwitchManufacturingDef' resource. operationId: CreateCapabilitySwitchManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.capability.SwitchManufacturingDef parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'capability.SwitchManufacturingDef' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/capability.SwitchManufacturingDef' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchManufacturingDef' resource was created as requested. The 'capability.SwitchManufacturingDef' 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/capability.SwitchManufacturingDef' links: GetCapabilitySwitchManufacturingDefByMoid: operationId: GetCapabilitySwitchManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchManufacturingDef' 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/capability.SwitchManufacturingDef' links: GetCapabilitySwitchManufacturingDefByMoid: operationId: GetCapabilitySwitchManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/capability/SwitchManufacturingDefs/{Moid}: get: tags: - capability summary: Read a 'capability.SwitchManufacturingDef' resource. operationId: GetCapabilitySwitchManufacturingDefByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.capability.SwitchManufacturingDef - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'capability.SwitchManufacturingDef' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchManufacturingDef' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetCapabilitySwitchManufacturingDefByMoid: operationId: GetCapabilitySwitchManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - capability summary: Update a 'capability.SwitchManufacturingDef' resource. operationId: UpdateCapabilitySwitchManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SwitchManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SwitchManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SwitchManufacturingDef' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchManufacturingDef' resource was modified as requested. The 'capability.SwitchManufacturingDef' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchManufacturingDef' links: GetCapabilitySwitchManufacturingDefByMoid: operationId: GetCapabilitySwitchManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchManufacturingDef' resource is asynchronously being modified 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/capability.SwitchManufacturingDef' links: GetCapabilitySwitchManufacturingDefByMoid: operationId: GetCapabilitySwitchManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - capability summary: Update a 'capability.SwitchManufacturingDef' resource. operationId: PatchCapabilitySwitchManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.capability.SwitchManufacturingDef parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'capability.SwitchManufacturingDef' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/capability.SwitchManufacturingDef' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'capability.SwitchManufacturingDef' resource was patched as requested. The 'capability.SwitchManufacturingDef' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/capability.SwitchManufacturingDef' links: GetCapabilitySwitchManufacturingDefByMoid: operationId: GetCapabilitySwitchManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'capability.SwitchManufacturingDef' resource is asynchronously being patched 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/capability.SwitchManufacturingDef' links: GetCapabilitySwitchManufacturingDefByMoid: operationId: GetCapabilitySwitchManufacturingDefByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - capability summary: Delete a 'capability.SwitchManufacturingDef' resource. operationId: DeleteCapabilitySwitchManufacturingDef security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.capability.SwitchManufacturingDef 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/Blades: get: tags: - compute summary: Read a 'compute.Blade' resource. operationId: GetComputeBladeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.compute.Blade - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'compute.Blade' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/compute.Blade.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/Blades/{Moid}: get: tags: - compute summary: Read a 'compute.Blade' resource. operationId: GetComputeBladeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.compute.Blade - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'compute.Blade' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/compute.Blade' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetComputeBladeByMoid: operationId: GetComputeBladeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - compute summary: Update a 'compute.Blade' resource. operationId: UpdateComputeBlade security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.Blade parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.Blade' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.Blade' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Blade' resource was modified as requested. The 'compute.Blade' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.Blade' links: GetComputeBladeByMoid: operationId: GetComputeBladeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.Blade' resource is asynchronously being modified 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/compute.Blade' links: GetComputeBladeByMoid: operationId: GetComputeBladeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - compute summary: Update a 'compute.Blade' resource. operationId: PatchComputeBlade security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.Blade parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.Blade' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.Blade' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Blade' resource was patched as requested. The 'compute.Blade' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.Blade' links: GetComputeBladeByMoid: operationId: GetComputeBladeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.Blade' resource is asynchronously being patched 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/compute.Blade' links: GetComputeBladeByMoid: operationId: GetComputeBladeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/BladeIdentities: get: tags: - compute summary: Read a 'compute.BladeIdentity' resource. operationId: GetComputeBladeIdentityList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.BladeIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'compute.BladeIdentity' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/compute.BladeIdentity.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/BladeIdentities/{Moid}: get: tags: - compute summary: Read a 'compute.BladeIdentity' resource. operationId: GetComputeBladeIdentityByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.BladeIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'compute.BladeIdentity' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/compute.BladeIdentity' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetComputeBladeIdentityByMoid: operationId: GetComputeBladeIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - compute summary: Update a 'compute.BladeIdentity' resource. operationId: UpdateComputeBladeIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.BladeIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.BladeIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.BladeIdentity' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.BladeIdentity' resource was modified as requested. The 'compute.BladeIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.BladeIdentity' links: GetComputeBladeIdentityByMoid: operationId: GetComputeBladeIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.BladeIdentity' resource is asynchronously being modified 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/compute.BladeIdentity' links: GetComputeBladeIdentityByMoid: operationId: GetComputeBladeIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - compute summary: Update a 'compute.BladeIdentity' resource. operationId: PatchComputeBladeIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.BladeIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.BladeIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.BladeIdentity' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.BladeIdentity' resource was patched as requested. The 'compute.BladeIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.BladeIdentity' links: GetComputeBladeIdentityByMoid: operationId: GetComputeBladeIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.BladeIdentity' resource is asynchronously being patched 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/compute.BladeIdentity' links: GetComputeBladeIdentityByMoid: operationId: GetComputeBladeIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - compute summary: Delete a 'compute.BladeIdentity' resource. operationId: DeleteComputeBladeIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.compute.BladeIdentity 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/Boards: get: tags: - compute summary: Read a 'compute.Board' resource. operationId: GetComputeBoardList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.Board - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'compute.Board' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/compute.Board.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/Boards/{Moid}: get: tags: - compute summary: Read a 'compute.Board' resource. operationId: GetComputeBoardByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.Board - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'compute.Board' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/compute.Board' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetComputeBoardByMoid: operationId: GetComputeBoardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - compute summary: Update a 'compute.Board' resource. operationId: UpdateComputeBoard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.Board parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.Board' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.Board' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Board' resource was modified as requested. The 'compute.Board' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.Board' links: GetComputeBoardByMoid: operationId: GetComputeBoardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.Board' resource is asynchronously being modified 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/compute.Board' links: GetComputeBoardByMoid: operationId: GetComputeBoardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - compute summary: Update a 'compute.Board' resource. operationId: PatchComputeBoard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.Board parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.Board' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.Board' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Board' resource was patched as requested. The 'compute.Board' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.Board' links: GetComputeBoardByMoid: operationId: GetComputeBoardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.Board' resource is asynchronously being patched 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/compute.Board' links: GetComputeBoardByMoid: operationId: GetComputeBoardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/PhysicalSummaries: get: tags: - compute summary: Read a 'compute.PhysicalSummary' resource. operationId: GetComputePhysicalSummaryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.compute.PhysicalSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'compute.PhysicalSummary' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/compute.PhysicalSummary.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/PhysicalSummaries/{Moid}: get: tags: - compute summary: Read a 'compute.PhysicalSummary' resource. operationId: GetComputePhysicalSummaryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.compute.PhysicalSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'compute.PhysicalSummary' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/compute.PhysicalSummary' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetComputePhysicalSummaryByMoid: operationId: GetComputePhysicalSummaryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/PhysicalSummaries/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/RackUnits: get: tags: - compute summary: Read a 'compute.RackUnit' resource. operationId: GetComputeRackUnitList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.compute.RackUnit - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'compute.RackUnit' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/compute.RackUnit.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/RackUnits/{Moid}: get: tags: - compute summary: Read a 'compute.RackUnit' resource. operationId: GetComputeRackUnitByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.compute.RackUnit - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'compute.RackUnit' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/compute.RackUnit' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetComputeRackUnitByMoid: operationId: GetComputeRackUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - compute summary: Update a 'compute.RackUnit' resource. operationId: UpdateComputeRackUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.RackUnit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.RackUnit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.RackUnit' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnit' resource was modified as requested. The 'compute.RackUnit' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.RackUnit' links: GetComputeRackUnitByMoid: operationId: GetComputeRackUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.RackUnit' resource is asynchronously being modified 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/compute.RackUnit' links: GetComputeRackUnitByMoid: operationId: GetComputeRackUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - compute summary: Update a 'compute.RackUnit' resource. operationId: PatchComputeRackUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.RackUnit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.RackUnit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.RackUnit' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnit' resource was patched as requested. The 'compute.RackUnit' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.RackUnit' links: GetComputeRackUnitByMoid: operationId: GetComputeRackUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.RackUnit' resource is asynchronously being patched 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/compute.RackUnit' links: GetComputeRackUnitByMoid: operationId: GetComputeRackUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/RackUnitIdentities: get: tags: - compute summary: Read a 'compute.RackUnitIdentity' resource. operationId: GetComputeRackUnitIdentityList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.RackUnitIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'compute.RackUnitIdentity' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/compute.RackUnitIdentity.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/RackUnitIdentities/{Moid}: get: tags: - compute summary: Read a 'compute.RackUnitIdentity' resource. operationId: GetComputeRackUnitIdentityByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.RackUnitIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'compute.RackUnitIdentity' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/compute.RackUnitIdentity' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetComputeRackUnitIdentityByMoid: operationId: GetComputeRackUnitIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - compute summary: Update a 'compute.RackUnitIdentity' resource. operationId: UpdateComputeRackUnitIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.RackUnitIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.RackUnitIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.RackUnitIdentity' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnitIdentity' resource was modified as requested. The 'compute.RackUnitIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.RackUnitIdentity' links: GetComputeRackUnitIdentityByMoid: operationId: GetComputeRackUnitIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.RackUnitIdentity' resource is asynchronously being modified 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/compute.RackUnitIdentity' links: GetComputeRackUnitIdentityByMoid: operationId: GetComputeRackUnitIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - compute summary: Update a 'compute.RackUnitIdentity' resource. operationId: PatchComputeRackUnitIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.RackUnitIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.RackUnitIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.RackUnitIdentity' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnitIdentity' resource was patched as requested. The 'compute.RackUnitIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.RackUnitIdentity' links: GetComputeRackUnitIdentityByMoid: operationId: GetComputeRackUnitIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.RackUnitIdentity' resource is asynchronously being patched 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/compute.RackUnitIdentity' links: GetComputeRackUnitIdentityByMoid: operationId: GetComputeRackUnitIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - compute summary: Delete a 'compute.RackUnitIdentity' resource. operationId: DeleteComputeRackUnitIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.compute.RackUnitIdentity 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/ServerSettings: get: tags: - compute summary: Read a 'compute.ServerSetting' resource. operationId: GetComputeServerSettingList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.ServerSetting - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'compute.ServerSetting' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/compute.ServerSetting.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/compute/ServerSettings/{Moid}: get: tags: - compute summary: Read a 'compute.ServerSetting' resource. operationId: GetComputeServerSettingByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.compute.ServerSetting - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'compute.ServerSetting' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/compute.ServerSetting' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetComputeServerSettingByMoid: operationId: GetComputeServerSettingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - compute summary: Update a 'compute.ServerSetting' resource. operationId: UpdateComputeServerSetting security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.ServerSetting parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.ServerSetting' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.ServerSetting' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ServerSetting' resource was modified as requested. The 'compute.ServerSetting' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.ServerSetting' links: GetComputeServerSettingByMoid: operationId: GetComputeServerSettingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.ServerSetting' resource is asynchronously being modified 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/compute.ServerSetting' links: GetComputeServerSettingByMoid: operationId: GetComputeServerSettingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - compute summary: Update a 'compute.ServerSetting' resource. operationId: PatchComputeServerSetting security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.compute.ServerSetting parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'compute.ServerSetting' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/compute.ServerSetting' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ServerSetting' resource was patched as requested. The 'compute.ServerSetting' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/compute.ServerSetting' links: GetComputeServerSettingByMoid: operationId: GetComputeServerSettingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'compute.ServerSetting' resource is asynchronously being patched 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/compute.ServerSetting' links: GetComputeServerSettingByMoid: operationId: GetComputeServerSettingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/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 Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.cond.Alarm - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/cond.Alarm.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.cond.Alarm - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/cond.Alarm' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'cond.Alarm' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'cond.Alarm' resource is asynchronously being patched 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/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 Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.cond.AlarmAggregation - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/cond.AlarmAggregation.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.cond.AlarmAggregation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/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.View Servers - READ.cond.HclStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/cond.HclStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Servers - READ.cond.HclStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.View Servers - READ.cond.HclStatusDetail - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/cond.HclStatusDetail.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Servers - READ.cond.HclStatusDetail - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.View Servers - READ.cond.HclStatusJob - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/cond.HclStatusJob.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Servers - READ.cond.HclStatusJob - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/config/ExportedItems: get: tags: - config summary: Read a 'config.ExportedItem' resource. operationId: GetConfigExportedItemList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Exports - READ.config.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 'config.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: # Response as JSON document. schema: $ref: '#/components/schemas/config.ExportedItem.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/config/ExportedItems/{Moid}: get: tags: - config summary: Read a 'config.ExportedItem' resource. operationId: GetConfigExportedItemByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Exports - READ.config.ExportedItem - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'config.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/config.ExportedItem' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetConfigExportedItemByMoid: operationId: GetConfigExportedItemByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/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/config/Exporters: get: tags: - config summary: Read a 'config.Exporter' resource. operationId: GetConfigExporterList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Exports - PRIVSET.View Exports - READ.config.Exporter - 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 'config.Exporter' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/config.Exporter.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - config summary: Create a 'config.Exporter' resource. operationId: CreateConfigExporter security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.config.Exporter - PRIVSET.Account Administrator - PRIVSET.Manage Exports - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'config.Exporter' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/config.Exporter' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'config.Exporter' resource was created as requested. The 'config.Exporter' 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/config.Exporter' links: GetConfigExporterByMoid: operationId: GetConfigExporterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/Exporters/{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 'config.Exporter' 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/config.Exporter' links: GetConfigExporterByMoid: operationId: GetConfigExporterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/Exporters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/config/Exporters/{Moid}: get: tags: - config summary: Read a 'config.Exporter' resource. operationId: GetConfigExporterByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Exports - PRIVSET.View Exports - READ.config.Exporter - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'config.Exporter' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/config.Exporter' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetConfigExporterByMoid: operationId: GetConfigExporterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/Exporters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - config summary: Delete a 'config.Exporter' resource. operationId: DeleteConfigExporter security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.config.Exporter - PRIVSET.Account Administrator - PRIVSET.Manage Exports - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/config/ImportedItems: get: tags: - config summary: Read a 'config.ImportedItem' resource. operationId: GetConfigImportedItemList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Imports - READ.config.ImportedItem - 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 'config.ImportedItem' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/config.ImportedItem.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/config/ImportedItems/{Moid}: get: tags: - config summary: Read a 'config.ImportedItem' resource. operationId: GetConfigImportedItemByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Imports - READ.config.ImportedItem - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'config.ImportedItem' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/config.ImportedItem' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetConfigImportedItemByMoid: operationId: GetConfigImportedItemByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/ImportedItems/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/config/Importers: get: tags: - config summary: Read a 'config.Importer' resource. operationId: GetConfigImporterList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Imports - PRIVSET.View Imports - READ.config.Importer - 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 'config.Importer' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/config.Importer.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - config summary: Create a 'config.Importer' resource. operationId: CreateConfigImporter security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.config.Importer - PRIVSET.Account Administrator - PRIVSET.Manage Imports - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'config.Importer' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/config.Importer' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'config.Importer' resource was created as requested. The 'config.Importer' 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/config.Importer' links: GetConfigImporterByMoid: operationId: GetConfigImporterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/Importers/{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 'config.Importer' 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/config.Importer' links: GetConfigImporterByMoid: operationId: GetConfigImporterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/Importers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/config/Importers/{Moid}: get: tags: - config summary: Read a 'config.Importer' resource. operationId: GetConfigImporterByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Imports - PRIVSET.View Imports - READ.config.Importer - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'config.Importer' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/config.Importer' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetConfigImporterByMoid: operationId: GetConfigImporterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/config/Importers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - config summary: Delete a 'config.Importer' resource. operationId: DeleteConfigImporter security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.config.Importer - PRIVSET.Account Administrator - PRIVSET.Manage Imports - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/connectorpack/ConnectorPackUpgrades: get: tags: - connectorpack summary: Read a 'connectorpack.ConnectorPackUpgrade' resource. operationId: GetConnectorpackConnectorPackUpgradeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.connectorpack.ConnectorPackUpgrade - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'connectorpack.ConnectorPackUpgrade' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/connectorpack.ConnectorPackUpgrade.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - connectorpack summary: Create a 'connectorpack.ConnectorPackUpgrade' resource. operationId: CreateConnectorpackConnectorPackUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.connectorpack.ConnectorPackUpgrade - PRIVSET.Account Administrator - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'connectorpack.ConnectorPackUpgrade' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/connectorpack.ConnectorPackUpgrade' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'connectorpack.ConnectorPackUpgrade' resource was created as requested. The 'connectorpack.ConnectorPackUpgrade' 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/connectorpack.ConnectorPackUpgrade' links: GetConnectorpackConnectorPackUpgradeByMoid: operationId: GetConnectorpackConnectorPackUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/ConnectorPackUpgrades/{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 'connectorpack.ConnectorPackUpgrade' 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/connectorpack.ConnectorPackUpgrade' links: GetConnectorpackConnectorPackUpgradeByMoid: operationId: GetConnectorpackConnectorPackUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/ConnectorPackUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/connectorpack/ConnectorPackUpgrades/{Moid}: get: tags: - connectorpack summary: Read a 'connectorpack.ConnectorPackUpgrade' resource. operationId: GetConnectorpackConnectorPackUpgradeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.connectorpack.ConnectorPackUpgrade - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'connectorpack.ConnectorPackUpgrade' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/connectorpack.ConnectorPackUpgrade' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetConnectorpackConnectorPackUpgradeByMoid: operationId: GetConnectorpackConnectorPackUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/ConnectorPackUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - connectorpack summary: Delete a 'connectorpack.ConnectorPackUpgrade' resource. operationId: DeleteConnectorpackConnectorPackUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.connectorpack.ConnectorPackUpgrade - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/connectorpack/UpgradeImpacts: get: tags: - connectorpack summary: Read a 'connectorpack.UpgradeImpact' resource. operationId: GetConnectorpackUpgradeImpactList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.connectorpack.UpgradeImpact - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'connectorpack.UpgradeImpact' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/connectorpack.UpgradeImpact.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/connectorpack/UpgradeImpacts/{Moid}: get: tags: - connectorpack summary: Read a 'connectorpack.UpgradeImpact' resource. operationId: GetConnectorpackUpgradeImpactByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.connectorpack.UpgradeImpact - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'connectorpack.UpgradeImpact' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/connectorpack.UpgradeImpact' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetConnectorpackUpgradeImpactByMoid: operationId: GetConnectorpackUpgradeImpactByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/UpgradeImpacts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/deviceconnector/Policies: post: tags: - deviceconnector summary: Create a 'deviceconnector.Policy' resource. operationId: CreateDeviceconnectorPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.deviceconnector.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'deviceconnector.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/deviceconnector.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'deviceconnector.Policy' resource was created as requested. The 'deviceconnector.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/deviceconnector.Policy' links: GetDeviceconnectorPolicyByMoid: operationId: GetDeviceconnectorPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'deviceconnector.Policy' 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/deviceconnector.Policy' links: GetDeviceconnectorPolicyByMoid: operationId: GetDeviceconnectorPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - deviceconnector summary: Read a 'deviceconnector.Policy' resource. operationId: GetDeviceconnectorPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.deviceconnector.Policy - 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 'deviceconnector.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/deviceconnector.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/deviceconnector/Policies/{Moid}: get: tags: - deviceconnector summary: Read a 'deviceconnector.Policy' resource. operationId: GetDeviceconnectorPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.deviceconnector.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'deviceconnector.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/deviceconnector.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetDeviceconnectorPolicyByMoid: operationId: GetDeviceconnectorPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - deviceconnector summary: Update a 'deviceconnector.Policy' resource. operationId: UpdateDeviceconnectorPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.deviceconnector.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'deviceconnector.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/deviceconnector.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'deviceconnector.Policy' resource was modified as requested. The 'deviceconnector.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/deviceconnector.Policy' links: GetDeviceconnectorPolicyByMoid: operationId: GetDeviceconnectorPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'deviceconnector.Policy' resource is asynchronously being modified 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/deviceconnector.Policy' links: GetDeviceconnectorPolicyByMoid: operationId: GetDeviceconnectorPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - deviceconnector summary: Update a 'deviceconnector.Policy' resource. operationId: PatchDeviceconnectorPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.deviceconnector.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'deviceconnector.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/deviceconnector.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 'deviceconnector.Policy' resource was patched as requested. The 'deviceconnector.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/deviceconnector.Policy' links: GetDeviceconnectorPolicyByMoid: operationId: GetDeviceconnectorPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'deviceconnector.Policy' resource is asynchronously being patched 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/deviceconnector.Policy' links: GetDeviceconnectorPolicyByMoid: operationId: GetDeviceconnectorPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - deviceconnector summary: Delete a 'deviceconnector.Policy' resource. operationId: DeleteDeviceconnectorPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.deviceconnector.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Chasses: get: tags: - equipment summary: Read a 'equipment.Chassis' resource. operationId: GetEquipmentChassisList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.Chassis - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.Chassis' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.Chassis.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Chasses/{Moid}: get: tags: - equipment summary: Read a 'equipment.Chassis' resource. operationId: GetEquipmentChassisByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.Chassis - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.Chassis' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.Chassis' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentChassisByMoid: operationId: GetEquipmentChassisByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.Chassis' resource. operationId: UpdateEquipmentChassis security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Chassis parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Chassis' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Chassis' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Chassis' resource was modified as requested. The 'equipment.Chassis' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Chassis' links: GetEquipmentChassisByMoid: operationId: GetEquipmentChassisByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Chassis' resource is asynchronously being modified 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/equipment.Chassis' links: GetEquipmentChassisByMoid: operationId: GetEquipmentChassisByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.Chassis' resource. operationId: PatchEquipmentChassis security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Chassis parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Chassis' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Chassis' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Chassis' resource was patched as requested. The 'equipment.Chassis' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Chassis' links: GetEquipmentChassisByMoid: operationId: GetEquipmentChassisByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Chassis' resource is asynchronously being patched 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/equipment.Chassis' links: GetEquipmentChassisByMoid: operationId: GetEquipmentChassisByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/ChassisIdentities: get: tags: - equipment summary: Read a 'equipment.ChassisIdentity' resource. operationId: GetEquipmentChassisIdentityList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.ChassisIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.ChassisIdentity' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.ChassisIdentity.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/ChassisIdentities/{Moid}: get: tags: - equipment summary: Read a 'equipment.ChassisIdentity' resource. operationId: GetEquipmentChassisIdentityByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.ChassisIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.ChassisIdentity' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.ChassisIdentity' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentChassisIdentityByMoid: operationId: GetEquipmentChassisIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.ChassisIdentity' resource. operationId: UpdateEquipmentChassisIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.ChassisIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.ChassisIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.ChassisIdentity' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisIdentity' resource was modified as requested. The 'equipment.ChassisIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.ChassisIdentity' links: GetEquipmentChassisIdentityByMoid: operationId: GetEquipmentChassisIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.ChassisIdentity' resource is asynchronously being modified 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/equipment.ChassisIdentity' links: GetEquipmentChassisIdentityByMoid: operationId: GetEquipmentChassisIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.ChassisIdentity' resource. operationId: PatchEquipmentChassisIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.ChassisIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.ChassisIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.ChassisIdentity' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisIdentity' resource was patched as requested. The 'equipment.ChassisIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.ChassisIdentity' links: GetEquipmentChassisIdentityByMoid: operationId: GetEquipmentChassisIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.ChassisIdentity' resource is asynchronously being patched 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/equipment.ChassisIdentity' links: GetEquipmentChassisIdentityByMoid: operationId: GetEquipmentChassisIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/DeviceSummaries: get: tags: - equipment summary: Read a 'equipment.DeviceSummary' resource. operationId: GetEquipmentDeviceSummaryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.equipment.DeviceSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.DeviceSummary' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.DeviceSummary.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/DeviceSummaries/{Moid}: get: tags: - equipment summary: Read a 'equipment.DeviceSummary' resource. operationId: GetEquipmentDeviceSummaryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Server Profiles - PRIVSET.View Servers - READ.equipment.DeviceSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.DeviceSummary' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.DeviceSummary' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentDeviceSummaryByMoid: operationId: GetEquipmentDeviceSummaryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/DeviceSummaries/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Fans: get: tags: - equipment summary: Read a 'equipment.Fan' resource. operationId: GetEquipmentFanList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.Fan - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.Fan' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.Fan.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Fans/{Moid}: get: tags: - equipment summary: Read a 'equipment.Fan' resource. operationId: GetEquipmentFanByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.Fan - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.Fan' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.Fan' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentFanByMoid: operationId: GetEquipmentFanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.Fan' resource. operationId: UpdateEquipmentFan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Fan parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Fan' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Fan' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fan' resource was modified as requested. The 'equipment.Fan' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Fan' links: GetEquipmentFanByMoid: operationId: GetEquipmentFanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Fan' resource is asynchronously being modified 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/equipment.Fan' links: GetEquipmentFanByMoid: operationId: GetEquipmentFanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.Fan' resource. operationId: PatchEquipmentFan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Fan parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Fan' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Fan' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fan' resource was patched as requested. The 'equipment.Fan' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Fan' links: GetEquipmentFanByMoid: operationId: GetEquipmentFanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Fan' resource is asynchronously being patched 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/equipment.Fan' links: GetEquipmentFanByMoid: operationId: GetEquipmentFanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/FanModules: get: tags: - equipment summary: Read a 'equipment.FanModule' resource. operationId: GetEquipmentFanModuleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.FanModule - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.FanModule' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.FanModule.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/FanModules/{Moid}: get: tags: - equipment summary: Read a 'equipment.FanModule' resource. operationId: GetEquipmentFanModuleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.FanModule - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.FanModule' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.FanModule' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentFanModuleByMoid: operationId: GetEquipmentFanModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.FanModule' resource. operationId: UpdateEquipmentFanModule security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.FanModule parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.FanModule' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.FanModule' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FanModule' resource was modified as requested. The 'equipment.FanModule' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.FanModule' links: GetEquipmentFanModuleByMoid: operationId: GetEquipmentFanModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.FanModule' resource is asynchronously being modified 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/equipment.FanModule' links: GetEquipmentFanModuleByMoid: operationId: GetEquipmentFanModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.FanModule' resource. operationId: PatchEquipmentFanModule security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.FanModule parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.FanModule' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.FanModule' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FanModule' resource was patched as requested. The 'equipment.FanModule' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.FanModule' links: GetEquipmentFanModuleByMoid: operationId: GetEquipmentFanModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.FanModule' resource is asynchronously being patched 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/equipment.FanModule' links: GetEquipmentFanModuleByMoid: operationId: GetEquipmentFanModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Fexes: get: tags: - equipment summary: Read a 'equipment.Fex' resource. operationId: GetEquipmentFexList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.Fex - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'equipment.Fex' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.Fex.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Fexes/{Moid}: get: tags: - equipment summary: Read a 'equipment.Fex' resource. operationId: GetEquipmentFexByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.Fex - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.Fex' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.Fex' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentFexByMoid: operationId: GetEquipmentFexByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.Fex' resource. operationId: UpdateEquipmentFex security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.Fex parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Fex' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Fex' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fex' resource was modified as requested. The 'equipment.Fex' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Fex' links: GetEquipmentFexByMoid: operationId: GetEquipmentFexByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Fex' resource is asynchronously being modified 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/equipment.Fex' links: GetEquipmentFexByMoid: operationId: GetEquipmentFexByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.Fex' resource. operationId: PatchEquipmentFex security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.Fex parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Fex' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Fex' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fex' resource was patched as requested. The 'equipment.Fex' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Fex' links: GetEquipmentFexByMoid: operationId: GetEquipmentFexByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Fex' resource is asynchronously being patched 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/equipment.Fex' links: GetEquipmentFexByMoid: operationId: GetEquipmentFexByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/FexIdentities: get: tags: - equipment summary: Read a 'equipment.FexIdentity' resource. operationId: GetEquipmentFexIdentityList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.FexIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'equipment.FexIdentity' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.FexIdentity.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/FexIdentities/{Moid}: get: tags: - equipment summary: Read a 'equipment.FexIdentity' resource. operationId: GetEquipmentFexIdentityByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.FexIdentity - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.FexIdentity' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.FexIdentity' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentFexIdentityByMoid: operationId: GetEquipmentFexIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.FexIdentity' resource. operationId: UpdateEquipmentFexIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.FexIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.FexIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.FexIdentity' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexIdentity' resource was modified as requested. The 'equipment.FexIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.FexIdentity' links: GetEquipmentFexIdentityByMoid: operationId: GetEquipmentFexIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.FexIdentity' resource is asynchronously being modified 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/equipment.FexIdentity' links: GetEquipmentFexIdentityByMoid: operationId: GetEquipmentFexIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.FexIdentity' resource. operationId: PatchEquipmentFexIdentity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.FexIdentity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.FexIdentity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.FexIdentity' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexIdentity' resource was patched as requested. The 'equipment.FexIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.FexIdentity' links: GetEquipmentFexIdentityByMoid: operationId: GetEquipmentFexIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.FexIdentity' resource is asynchronously being patched 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/equipment.FexIdentity' links: GetEquipmentFexIdentityByMoid: operationId: GetEquipmentFexIdentityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/FexOperations: get: tags: - equipment summary: Read a 'equipment.FexOperation' resource. operationId: GetEquipmentFexOperationList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.FexOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'equipment.FexOperation' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.FexOperation.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/FexOperations/{Moid}: get: tags: - equipment summary: Read a 'equipment.FexOperation' resource. operationId: GetEquipmentFexOperationByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.FexOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.FexOperation' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.FexOperation' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentFexOperationByMoid: operationId: GetEquipmentFexOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.FexOperation' resource. operationId: UpdateEquipmentFexOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.FexOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.FexOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.FexOperation' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexOperation' resource was modified as requested. The 'equipment.FexOperation' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.FexOperation' links: GetEquipmentFexOperationByMoid: operationId: GetEquipmentFexOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.FexOperation' resource is asynchronously being modified 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/equipment.FexOperation' links: GetEquipmentFexOperationByMoid: operationId: GetEquipmentFexOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.FexOperation' resource. operationId: PatchEquipmentFexOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.FexOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.FexOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.FexOperation' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexOperation' resource was patched as requested. The 'equipment.FexOperation' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.FexOperation' links: GetEquipmentFexOperationByMoid: operationId: GetEquipmentFexOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.FexOperation' resource is asynchronously being patched 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/equipment.FexOperation' links: GetEquipmentFexOperationByMoid: operationId: GetEquipmentFexOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IdentitySummaries: get: tags: - equipment summary: Read a 'equipment.IdentitySummary' resource. operationId: GetEquipmentIdentitySummaryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.IdentitySummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.IdentitySummary' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.IdentitySummary.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IdentitySummaries/{Moid}: get: tags: - equipment summary: Read a 'equipment.IdentitySummary' resource. operationId: GetEquipmentIdentitySummaryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.IdentitySummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.IdentitySummary' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.IdentitySummary' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentIdentitySummaryByMoid: operationId: GetEquipmentIdentitySummaryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IdentitySummaries/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IoCards: get: tags: - equipment summary: Read a 'equipment.IoCard' resource. operationId: GetEquipmentIoCardList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.IoCard - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.IoCard' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.IoCard.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IoCards/{Moid}: get: tags: - equipment summary: Read a 'equipment.IoCard' resource. operationId: GetEquipmentIoCardByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.IoCard - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.IoCard' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.IoCard' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentIoCardByMoid: operationId: GetEquipmentIoCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.IoCard' resource. operationId: UpdateEquipmentIoCard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.IoCard parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.IoCard' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.IoCard' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCard' resource was modified as requested. The 'equipment.IoCard' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.IoCard' links: GetEquipmentIoCardByMoid: operationId: GetEquipmentIoCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.IoCard' resource is asynchronously being modified 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/equipment.IoCard' links: GetEquipmentIoCardByMoid: operationId: GetEquipmentIoCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.IoCard' resource. operationId: PatchEquipmentIoCard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.IoCard parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.IoCard' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.IoCard' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCard' resource was patched as requested. The 'equipment.IoCard' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.IoCard' links: GetEquipmentIoCardByMoid: operationId: GetEquipmentIoCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.IoCard' resource is asynchronously being patched 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/equipment.IoCard' links: GetEquipmentIoCardByMoid: operationId: GetEquipmentIoCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IoCardOperations: get: tags: - equipment summary: Read a 'equipment.IoCardOperation' resource. operationId: GetEquipmentIoCardOperationList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.IoCardOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'equipment.IoCardOperation' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.IoCardOperation.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IoCardOperations/{Moid}: get: tags: - equipment summary: Read a 'equipment.IoCardOperation' resource. operationId: GetEquipmentIoCardOperationByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.IoCardOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.IoCardOperation' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.IoCardOperation' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentIoCardOperationByMoid: operationId: GetEquipmentIoCardOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.IoCardOperation' resource. operationId: UpdateEquipmentIoCardOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.IoCardOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.IoCardOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.IoCardOperation' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCardOperation' resource was modified as requested. The 'equipment.IoCardOperation' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.IoCardOperation' links: GetEquipmentIoCardOperationByMoid: operationId: GetEquipmentIoCardOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.IoCardOperation' resource is asynchronously being modified 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/equipment.IoCardOperation' links: GetEquipmentIoCardOperationByMoid: operationId: GetEquipmentIoCardOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.IoCardOperation' resource. operationId: PatchEquipmentIoCardOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.IoCardOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.IoCardOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.IoCardOperation' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCardOperation' resource was patched as requested. The 'equipment.IoCardOperation' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.IoCardOperation' links: GetEquipmentIoCardOperationByMoid: operationId: GetEquipmentIoCardOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.IoCardOperation' resource is asynchronously being patched 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/equipment.IoCardOperation' links: GetEquipmentIoCardOperationByMoid: operationId: GetEquipmentIoCardOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IoExpanders: get: tags: - equipment summary: Read a 'equipment.IoExpander' resource. operationId: GetEquipmentIoExpanderList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.IoExpander - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.IoExpander' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.IoExpander.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/IoExpanders/{Moid}: get: tags: - equipment summary: Read a 'equipment.IoExpander' resource. operationId: GetEquipmentIoExpanderByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.IoExpander - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.IoExpander' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.IoExpander' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentIoExpanderByMoid: operationId: GetEquipmentIoExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.IoExpander' resource. operationId: UpdateEquipmentIoExpander security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.IoExpander parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.IoExpander' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.IoExpander' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoExpander' resource was modified as requested. The 'equipment.IoExpander' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.IoExpander' links: GetEquipmentIoExpanderByMoid: operationId: GetEquipmentIoExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.IoExpander' resource is asynchronously being modified 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/equipment.IoExpander' links: GetEquipmentIoExpanderByMoid: operationId: GetEquipmentIoExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.IoExpander' resource. operationId: PatchEquipmentIoExpander security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.IoExpander parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.IoExpander' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.IoExpander' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoExpander' resource was patched as requested. The 'equipment.IoExpander' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.IoExpander' links: GetEquipmentIoExpanderByMoid: operationId: GetEquipmentIoExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.IoExpander' resource is asynchronously being patched 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/equipment.IoExpander' links: GetEquipmentIoExpanderByMoid: operationId: GetEquipmentIoExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/LocatorLeds: get: tags: - equipment summary: Read a 'equipment.LocatorLed' resource. operationId: GetEquipmentLocatorLedList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.LocatorLed - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.LocatorLed' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.LocatorLed.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/LocatorLeds/{Moid}: get: tags: - equipment summary: Read a 'equipment.LocatorLed' resource. operationId: GetEquipmentLocatorLedByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.LocatorLed - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.LocatorLed' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.LocatorLed' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentLocatorLedByMoid: operationId: GetEquipmentLocatorLedByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.LocatorLed' resource. operationId: UpdateEquipmentLocatorLed security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.LocatorLed parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.LocatorLed' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.LocatorLed' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.LocatorLed' resource was modified as requested. The 'equipment.LocatorLed' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.LocatorLed' links: GetEquipmentLocatorLedByMoid: operationId: GetEquipmentLocatorLedByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.LocatorLed' resource is asynchronously being modified 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/equipment.LocatorLed' links: GetEquipmentLocatorLedByMoid: operationId: GetEquipmentLocatorLedByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.LocatorLed' resource. operationId: PatchEquipmentLocatorLed security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.LocatorLed parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.LocatorLed' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.LocatorLed' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.LocatorLed' resource was patched as requested. The 'equipment.LocatorLed' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.LocatorLed' links: GetEquipmentLocatorLedByMoid: operationId: GetEquipmentLocatorLedByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.LocatorLed' resource is asynchronously being patched 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/equipment.LocatorLed' links: GetEquipmentLocatorLedByMoid: operationId: GetEquipmentLocatorLedByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Psus: get: tags: - equipment summary: Read a 'equipment.Psu' resource. operationId: GetEquipmentPsuList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.Psu - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.Psu' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.Psu.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Psus/{Moid}: get: tags: - equipment summary: Read a 'equipment.Psu' resource. operationId: GetEquipmentPsuByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.Psu - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.Psu' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.Psu' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentPsuByMoid: operationId: GetEquipmentPsuByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.Psu' resource. operationId: UpdateEquipmentPsu security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Psu parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Psu' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Psu' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Psu' resource was modified as requested. The 'equipment.Psu' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Psu' links: GetEquipmentPsuByMoid: operationId: GetEquipmentPsuByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Psu' resource is asynchronously being modified 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/equipment.Psu' links: GetEquipmentPsuByMoid: operationId: GetEquipmentPsuByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.Psu' resource. operationId: PatchEquipmentPsu security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Psu parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Psu' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Psu' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Psu' resource was patched as requested. The 'equipment.Psu' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Psu' links: GetEquipmentPsuByMoid: operationId: GetEquipmentPsuByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Psu' resource is asynchronously being patched 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/equipment.Psu' links: GetEquipmentPsuByMoid: operationId: GetEquipmentPsuByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/PsuControls: get: tags: - equipment summary: Read a 'equipment.PsuControl' resource. operationId: GetEquipmentPsuControlList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.PsuControl - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.PsuControl' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.PsuControl.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/PsuControls/{Moid}: get: tags: - equipment summary: Read a 'equipment.PsuControl' resource. operationId: GetEquipmentPsuControlByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.equipment.PsuControl - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.PsuControl' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.PsuControl' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentPsuControlByMoid: operationId: GetEquipmentPsuControlByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.PsuControl' resource. operationId: UpdateEquipmentPsuControl security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.PsuControl parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.PsuControl' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.PsuControl' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.PsuControl' resource was modified as requested. The 'equipment.PsuControl' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.PsuControl' links: GetEquipmentPsuControlByMoid: operationId: GetEquipmentPsuControlByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.PsuControl' resource is asynchronously being modified 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/equipment.PsuControl' links: GetEquipmentPsuControlByMoid: operationId: GetEquipmentPsuControlByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.PsuControl' resource. operationId: PatchEquipmentPsuControl security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.PsuControl parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.PsuControl' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.PsuControl' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.PsuControl' resource was patched as requested. The 'equipment.PsuControl' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.PsuControl' links: GetEquipmentPsuControlByMoid: operationId: GetEquipmentPsuControlByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.PsuControl' resource is asynchronously being patched 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/equipment.PsuControl' links: GetEquipmentPsuControlByMoid: operationId: GetEquipmentPsuControlByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/RackEnclosures: get: tags: - equipment summary: Read a 'equipment.RackEnclosure' resource. operationId: GetEquipmentRackEnclosureList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.RackEnclosure - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.RackEnclosure' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.RackEnclosure.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/RackEnclosures/{Moid}: get: tags: - equipment summary: Read a 'equipment.RackEnclosure' resource. operationId: GetEquipmentRackEnclosureByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.RackEnclosure - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.RackEnclosure' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosure' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentRackEnclosureByMoid: operationId: GetEquipmentRackEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.RackEnclosure' resource. operationId: UpdateEquipmentRackEnclosure security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.RackEnclosure parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.RackEnclosure' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosure' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosure' resource was modified as requested. The 'equipment.RackEnclosure' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosure' links: GetEquipmentRackEnclosureByMoid: operationId: GetEquipmentRackEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.RackEnclosure' resource is asynchronously being modified 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/equipment.RackEnclosure' links: GetEquipmentRackEnclosureByMoid: operationId: GetEquipmentRackEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.RackEnclosure' resource. operationId: PatchEquipmentRackEnclosure security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.RackEnclosure parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.RackEnclosure' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosure' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosure' resource was patched as requested. The 'equipment.RackEnclosure' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosure' links: GetEquipmentRackEnclosureByMoid: operationId: GetEquipmentRackEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.RackEnclosure' resource is asynchronously being patched 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/equipment.RackEnclosure' links: GetEquipmentRackEnclosureByMoid: operationId: GetEquipmentRackEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/RackEnclosureSlots: get: tags: - equipment summary: Read a 'equipment.RackEnclosureSlot' resource. operationId: GetEquipmentRackEnclosureSlotList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.RackEnclosureSlot - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.RackEnclosureSlot' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.RackEnclosureSlot.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/RackEnclosureSlots/{Moid}: get: tags: - equipment summary: Read a 'equipment.RackEnclosureSlot' resource. operationId: GetEquipmentRackEnclosureSlotByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.RackEnclosureSlot - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.RackEnclosureSlot' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosureSlot' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentRackEnclosureSlotByMoid: operationId: GetEquipmentRackEnclosureSlotByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.RackEnclosureSlot' resource. operationId: UpdateEquipmentRackEnclosureSlot security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.RackEnclosureSlot parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.RackEnclosureSlot' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosureSlot' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosureSlot' resource was modified as requested. The 'equipment.RackEnclosureSlot' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosureSlot' links: GetEquipmentRackEnclosureSlotByMoid: operationId: GetEquipmentRackEnclosureSlotByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.RackEnclosureSlot' resource is asynchronously being modified 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/equipment.RackEnclosureSlot' links: GetEquipmentRackEnclosureSlotByMoid: operationId: GetEquipmentRackEnclosureSlotByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.RackEnclosureSlot' resource. operationId: PatchEquipmentRackEnclosureSlot security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.RackEnclosureSlot parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.RackEnclosureSlot' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosureSlot' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosureSlot' resource was patched as requested. The 'equipment.RackEnclosureSlot' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.RackEnclosureSlot' links: GetEquipmentRackEnclosureSlotByMoid: operationId: GetEquipmentRackEnclosureSlotByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.RackEnclosureSlot' resource is asynchronously being patched 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/equipment.RackEnclosureSlot' links: GetEquipmentRackEnclosureSlotByMoid: operationId: GetEquipmentRackEnclosureSlotByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/SharedIoModules: get: tags: - equipment summary: Read a 'equipment.SharedIoModule' resource. operationId: GetEquipmentSharedIoModuleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.SharedIoModule - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.SharedIoModule' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.SharedIoModule.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/SharedIoModules/{Moid}: get: tags: - equipment summary: Read a 'equipment.SharedIoModule' resource. operationId: GetEquipmentSharedIoModuleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.SharedIoModule - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.SharedIoModule' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.SharedIoModule' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentSharedIoModuleByMoid: operationId: GetEquipmentSharedIoModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.SharedIoModule' resource. operationId: UpdateEquipmentSharedIoModule security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.SharedIoModule parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.SharedIoModule' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.SharedIoModule' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SharedIoModule' resource was modified as requested. The 'equipment.SharedIoModule' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.SharedIoModule' links: GetEquipmentSharedIoModuleByMoid: operationId: GetEquipmentSharedIoModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.SharedIoModule' resource is asynchronously being modified 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/equipment.SharedIoModule' links: GetEquipmentSharedIoModuleByMoid: operationId: GetEquipmentSharedIoModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.SharedIoModule' resource. operationId: PatchEquipmentSharedIoModule security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.SharedIoModule parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.SharedIoModule' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.SharedIoModule' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SharedIoModule' resource was patched as requested. The 'equipment.SharedIoModule' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.SharedIoModule' links: GetEquipmentSharedIoModuleByMoid: operationId: GetEquipmentSharedIoModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.SharedIoModule' resource is asynchronously being patched 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/equipment.SharedIoModule' links: GetEquipmentSharedIoModuleByMoid: operationId: GetEquipmentSharedIoModuleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/SwitchCards: get: tags: - equipment summary: Read a 'equipment.SwitchCard' resource. operationId: GetEquipmentSwitchCardList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.SwitchCard - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'equipment.SwitchCard' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.SwitchCard.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/SwitchCards/{Moid}: get: tags: - equipment summary: Read a 'equipment.SwitchCard' resource. operationId: GetEquipmentSwitchCardByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.equipment.SwitchCard - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.SwitchCard' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.SwitchCard' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentSwitchCardByMoid: operationId: GetEquipmentSwitchCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.SwitchCard' resource. operationId: UpdateEquipmentSwitchCard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.SwitchCard parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.SwitchCard' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.SwitchCard' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SwitchCard' resource was modified as requested. The 'equipment.SwitchCard' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.SwitchCard' links: GetEquipmentSwitchCardByMoid: operationId: GetEquipmentSwitchCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.SwitchCard' resource is asynchronously being modified 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/equipment.SwitchCard' links: GetEquipmentSwitchCardByMoid: operationId: GetEquipmentSwitchCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.SwitchCard' resource. operationId: PatchEquipmentSwitchCard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.equipment.SwitchCard parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.SwitchCard' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.SwitchCard' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SwitchCard' resource was patched as requested. The 'equipment.SwitchCard' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.SwitchCard' links: GetEquipmentSwitchCardByMoid: operationId: GetEquipmentSwitchCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.SwitchCard' resource is asynchronously being patched 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/equipment.SwitchCard' links: GetEquipmentSwitchCardByMoid: operationId: GetEquipmentSwitchCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/SystemIoControllers: get: tags: - equipment summary: Read a 'equipment.SystemIoController' resource. operationId: GetEquipmentSystemIoControllerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.SystemIoController - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.SystemIoController' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.SystemIoController.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/SystemIoControllers/{Moid}: get: tags: - equipment summary: Read a 'equipment.SystemIoController' resource. operationId: GetEquipmentSystemIoControllerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.SystemIoController - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.SystemIoController' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.SystemIoController' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentSystemIoControllerByMoid: operationId: GetEquipmentSystemIoControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.SystemIoController' resource. operationId: UpdateEquipmentSystemIoController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.SystemIoController parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.SystemIoController' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.SystemIoController' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SystemIoController' resource was modified as requested. The 'equipment.SystemIoController' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.SystemIoController' links: GetEquipmentSystemIoControllerByMoid: operationId: GetEquipmentSystemIoControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.SystemIoController' resource is asynchronously being modified 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/equipment.SystemIoController' links: GetEquipmentSystemIoControllerByMoid: operationId: GetEquipmentSystemIoControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.SystemIoController' resource. operationId: PatchEquipmentSystemIoController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.SystemIoController parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.SystemIoController' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.SystemIoController' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SystemIoController' resource was patched as requested. The 'equipment.SystemIoController' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.SystemIoController' links: GetEquipmentSystemIoControllerByMoid: operationId: GetEquipmentSystemIoControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.SystemIoController' resource is asynchronously being patched 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/equipment.SystemIoController' links: GetEquipmentSystemIoControllerByMoid: operationId: GetEquipmentSystemIoControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Tpms: get: tags: - equipment summary: Read a 'equipment.Tpm' resource. operationId: GetEquipmentTpmList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.Tpm - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.Tpm' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.Tpm.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Tpms/{Moid}: get: tags: - equipment summary: Read a 'equipment.Tpm' resource. operationId: GetEquipmentTpmByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.Tpm - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.Tpm' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.Tpm' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentTpmByMoid: operationId: GetEquipmentTpmByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.Tpm' resource. operationId: UpdateEquipmentTpm security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Tpm parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Tpm' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Tpm' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Tpm' resource was modified as requested. The 'equipment.Tpm' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Tpm' links: GetEquipmentTpmByMoid: operationId: GetEquipmentTpmByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Tpm' resource is asynchronously being modified 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/equipment.Tpm' links: GetEquipmentTpmByMoid: operationId: GetEquipmentTpmByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.Tpm' resource. operationId: PatchEquipmentTpm security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Tpm parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Tpm' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Tpm' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Tpm' resource was patched as requested. The 'equipment.Tpm' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Tpm' links: GetEquipmentTpmByMoid: operationId: GetEquipmentTpmByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Tpm' resource is asynchronously being patched 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/equipment.Tpm' links: GetEquipmentTpmByMoid: operationId: GetEquipmentTpmByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Transceivers: get: tags: - equipment summary: Read a 'equipment.Transceiver' resource. operationId: GetEquipmentTransceiverList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.Transceiver - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'equipment.Transceiver' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/equipment.Transceiver.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/equipment/Transceivers/{Moid}: get: tags: - equipment summary: Read a 'equipment.Transceiver' resource. operationId: GetEquipmentTransceiverByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.equipment.Transceiver - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'equipment.Transceiver' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/equipment.Transceiver' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEquipmentTransceiverByMoid: operationId: GetEquipmentTransceiverByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - equipment summary: Update a 'equipment.Transceiver' resource. operationId: UpdateEquipmentTransceiver security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Transceiver parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Transceiver' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Transceiver' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Transceiver' resource was modified as requested. The 'equipment.Transceiver' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Transceiver' links: GetEquipmentTransceiverByMoid: operationId: GetEquipmentTransceiverByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Transceiver' resource is asynchronously being modified 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/equipment.Transceiver' links: GetEquipmentTransceiverByMoid: operationId: GetEquipmentTransceiverByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - equipment summary: Update a 'equipment.Transceiver' resource. operationId: PatchEquipmentTransceiver security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.equipment.Transceiver parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'equipment.Transceiver' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/equipment.Transceiver' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Transceiver' resource was patched as requested. The 'equipment.Transceiver' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/equipment.Transceiver' links: GetEquipmentTransceiverByMoid: operationId: GetEquipmentTransceiverByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'equipment.Transceiver' resource is asynchronously being patched 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/equipment.Transceiver' links: GetEquipmentTransceiverByMoid: operationId: GetEquipmentTransceiverByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/HostPorts: get: tags: - ether summary: Read a 'ether.HostPort' resource. operationId: GetEtherHostPortList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.HostPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'ether.HostPort' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ether.HostPort.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/HostPorts/{Moid}: get: tags: - ether summary: Read a 'ether.HostPort' resource. operationId: GetEtherHostPortByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.HostPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ether.HostPort' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ether.HostPort' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEtherHostPortByMoid: operationId: GetEtherHostPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/HostPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ether summary: Update a 'ether.HostPort' resource. operationId: UpdateEtherHostPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.ether.HostPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ether.HostPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ether.HostPort' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ether.HostPort' resource was modified as requested. The 'ether.HostPort' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ether.HostPort' links: GetEtherHostPortByMoid: operationId: GetEtherHostPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/HostPorts/{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 'ether.HostPort' resource is asynchronously being modified 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/ether.HostPort' links: GetEtherHostPortByMoid: operationId: GetEtherHostPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/HostPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ether summary: Update a 'ether.HostPort' resource. operationId: PatchEtherHostPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.ether.HostPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ether.HostPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ether.HostPort' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ether.HostPort' resource was patched as requested. The 'ether.HostPort' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ether.HostPort' links: GetEtherHostPortByMoid: operationId: GetEtherHostPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/HostPorts/{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 'ether.HostPort' resource is asynchronously being patched 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/ether.HostPort' links: GetEtherHostPortByMoid: operationId: GetEtherHostPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/HostPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/NetworkPorts: get: tags: - ether summary: Read a 'ether.NetworkPort' resource. operationId: GetEtherNetworkPortList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.NetworkPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'ether.NetworkPort' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ether.NetworkPort.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/NetworkPorts/{Moid}: get: tags: - ether summary: Read a 'ether.NetworkPort' resource. operationId: GetEtherNetworkPortByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.NetworkPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ether.NetworkPort' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ether.NetworkPort' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEtherNetworkPortByMoid: operationId: GetEtherNetworkPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/NetworkPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ether summary: Update a 'ether.NetworkPort' resource. operationId: UpdateEtherNetworkPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.ether.NetworkPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ether.NetworkPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ether.NetworkPort' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ether.NetworkPort' resource was modified as requested. The 'ether.NetworkPort' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ether.NetworkPort' links: GetEtherNetworkPortByMoid: operationId: GetEtherNetworkPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/NetworkPorts/{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 'ether.NetworkPort' resource is asynchronously being modified 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/ether.NetworkPort' links: GetEtherNetworkPortByMoid: operationId: GetEtherNetworkPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/NetworkPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ether summary: Update a 'ether.NetworkPort' resource. operationId: PatchEtherNetworkPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.ether.NetworkPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ether.NetworkPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ether.NetworkPort' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ether.NetworkPort' resource was patched as requested. The 'ether.NetworkPort' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ether.NetworkPort' links: GetEtherNetworkPortByMoid: operationId: GetEtherNetworkPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/NetworkPorts/{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 'ether.NetworkPort' resource is asynchronously being patched 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/ether.NetworkPort' links: GetEtherNetworkPortByMoid: operationId: GetEtherNetworkPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/NetworkPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/PhysicalPorts: get: tags: - ether summary: Read a 'ether.PhysicalPort' resource. operationId: GetEtherPhysicalPortList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.PhysicalPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'ether.PhysicalPort' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ether.PhysicalPort.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/PhysicalPorts/{Moid}: get: tags: - ether summary: Read a 'ether.PhysicalPort' resource. operationId: GetEtherPhysicalPortByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.PhysicalPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ether.PhysicalPort' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ether.PhysicalPort' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEtherPhysicalPortByMoid: operationId: GetEtherPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ether summary: Update a 'ether.PhysicalPort' resource. operationId: UpdateEtherPhysicalPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.ether.PhysicalPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ether.PhysicalPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ether.PhysicalPort' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ether.PhysicalPort' resource was modified as requested. The 'ether.PhysicalPort' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ether.PhysicalPort' links: GetEtherPhysicalPortByMoid: operationId: GetEtherPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{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 'ether.PhysicalPort' resource is asynchronously being modified 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/ether.PhysicalPort' links: GetEtherPhysicalPortByMoid: operationId: GetEtherPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ether summary: Update a 'ether.PhysicalPort' resource. operationId: PatchEtherPhysicalPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.ether.PhysicalPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ether.PhysicalPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ether.PhysicalPort' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ether.PhysicalPort' resource was patched as requested. The 'ether.PhysicalPort' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ether.PhysicalPort' links: GetEtherPhysicalPortByMoid: operationId: GetEtherPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{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 'ether.PhysicalPort' resource is asynchronously being patched 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/ether.PhysicalPort' links: GetEtherPhysicalPortByMoid: operationId: GetEtherPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/PortChannels: get: tags: - ether summary: Read a 'ether.PortChannel' resource. operationId: GetEtherPortChannelList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.PortChannel - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'ether.PortChannel' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ether.PortChannel.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ether/PortChannels/{Moid}: get: tags: - ether summary: Read a 'ether.PortChannel' resource. operationId: GetEtherPortChannelByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.ether.PortChannel - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ether.PortChannel' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ether.PortChannel' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetEtherPortChannelByMoid: operationId: GetEtherPortChannelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ether/PortChannels/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'externalsite.Authorization' 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/externalsite.Authorization.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/externalsite.Authorization' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'externalsite.Authorization' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'externalsite.Authorization' resource is asynchronously being patched 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/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/fabric/ConfigChangeDetails: get: tags: - fabric summary: Read a 'fabric.ConfigChangeDetail' resource. operationId: GetFabricConfigChangeDetailList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ConfigChangeDetail - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.ConfigChangeDetail' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.ConfigChangeDetail.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/ConfigChangeDetails/{Moid}: get: tags: - fabric summary: Read a 'fabric.ConfigChangeDetail' resource. operationId: GetFabricConfigChangeDetailByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ConfigChangeDetail - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.ConfigChangeDetail' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.ConfigChangeDetail' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricConfigChangeDetailByMoid: operationId: GetFabricConfigChangeDetailByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ConfigChangeDetails/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/ConfigResults: get: tags: - fabric summary: Read a 'fabric.ConfigResult' resource. operationId: GetFabricConfigResultList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ConfigResult - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.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: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.ConfigResult.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/ConfigResults/{Moid}: get: tags: - fabric summary: Read a 'fabric.ConfigResult' resource. operationId: GetFabricConfigResultByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ConfigResult - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.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/fabric.ConfigResult' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricConfigResultByMoid: operationId: GetFabricConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/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/fabric/ConfigResultEntries: get: tags: - fabric summary: Read a 'fabric.ConfigResultEntry' resource. operationId: GetFabricConfigResultEntryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ConfigResultEntry - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.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: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.ConfigResultEntry.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/ConfigResultEntries/{Moid}: get: tags: - fabric summary: Read a 'fabric.ConfigResultEntry' resource. operationId: GetFabricConfigResultEntryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ConfigResultEntry - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.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/fabric.ConfigResultEntry' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricConfigResultEntryByMoid: operationId: GetFabricConfigResultEntryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/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/fabric/EstimateImpacts: post: tags: - fabric summary: Create a 'fabric.EstimateImpact' resource. operationId: CreateFabricEstimateImpact security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.EstimateImpact - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.EstimateImpact' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.EstimateImpact' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EstimateImpact' resource was created as requested. The 'fabric.EstimateImpact' 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/fabric.EstimateImpact' links: GetFabricEstimateImpactByMoid: operationId: GetFabricEstimateImpactByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EstimateImpacts/{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 'fabric.EstimateImpact' 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/fabric.EstimateImpact' links: GetFabricEstimateImpactByMoid: operationId: GetFabricEstimateImpactByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EstimateImpacts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/EthNetworkControlPolicies: get: tags: - fabric summary: Read a 'fabric.EthNetworkControlPolicy' resource. operationId: GetFabricEthNetworkControlPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.fabric.EthNetworkControlPolicy - 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 'fabric.EthNetworkControlPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.EthNetworkControlPolicy' resource. operationId: CreateFabricEthNetworkControlPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.EthNetworkControlPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.EthNetworkControlPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkControlPolicy' resource was created as requested. The 'fabric.EthNetworkControlPolicy' 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/fabric.EthNetworkControlPolicy' links: GetFabricEthNetworkControlPolicyByMoid: operationId: GetFabricEthNetworkControlPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkControlPolicies/{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 'fabric.EthNetworkControlPolicy' 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/fabric.EthNetworkControlPolicy' links: GetFabricEthNetworkControlPolicyByMoid: operationId: GetFabricEthNetworkControlPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkControlPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/EthNetworkControlPolicies/{Moid}: get: tags: - fabric summary: Read a 'fabric.EthNetworkControlPolicy' resource. operationId: GetFabricEthNetworkControlPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.fabric.EthNetworkControlPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.EthNetworkControlPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricEthNetworkControlPolicyByMoid: operationId: GetFabricEthNetworkControlPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkControlPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.EthNetworkControlPolicy' resource. operationId: UpdateFabricEthNetworkControlPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.fabric.EthNetworkControlPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.EthNetworkControlPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkControlPolicy' resource was modified as requested. The 'fabric.EthNetworkControlPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' links: GetFabricEthNetworkControlPolicyByMoid: operationId: GetFabricEthNetworkControlPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkControlPolicies/{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 'fabric.EthNetworkControlPolicy' resource is asynchronously being modified 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/fabric.EthNetworkControlPolicy' links: GetFabricEthNetworkControlPolicyByMoid: operationId: GetFabricEthNetworkControlPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkControlPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.EthNetworkControlPolicy' resource. operationId: PatchFabricEthNetworkControlPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.fabric.EthNetworkControlPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.EthNetworkControlPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkControlPolicy' resource was patched as requested. The 'fabric.EthNetworkControlPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' links: GetFabricEthNetworkControlPolicyByMoid: operationId: GetFabricEthNetworkControlPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkControlPolicies/{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 'fabric.EthNetworkControlPolicy' resource is asynchronously being patched 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/fabric.EthNetworkControlPolicy' links: GetFabricEthNetworkControlPolicyByMoid: operationId: GetFabricEthNetworkControlPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkControlPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.EthNetworkControlPolicy' resource. operationId: DeleteFabricEthNetworkControlPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.EthNetworkControlPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/EthNetworkGroupPolicies: get: tags: - fabric summary: Read a 'fabric.EthNetworkGroupPolicy' resource. operationId: GetFabricEthNetworkGroupPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.fabric.EthNetworkGroupPolicy - 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 'fabric.EthNetworkGroupPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.EthNetworkGroupPolicy' resource. operationId: CreateFabricEthNetworkGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.EthNetworkGroupPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.EthNetworkGroupPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkGroupPolicy' resource was created as requested. The 'fabric.EthNetworkGroupPolicy' 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/fabric.EthNetworkGroupPolicy' links: GetFabricEthNetworkGroupPolicyByMoid: operationId: GetFabricEthNetworkGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkGroupPolicies/{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 'fabric.EthNetworkGroupPolicy' 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/fabric.EthNetworkGroupPolicy' links: GetFabricEthNetworkGroupPolicyByMoid: operationId: GetFabricEthNetworkGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/EthNetworkGroupPolicies/{Moid}: get: tags: - fabric summary: Read a 'fabric.EthNetworkGroupPolicy' resource. operationId: GetFabricEthNetworkGroupPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.fabric.EthNetworkGroupPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.EthNetworkGroupPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricEthNetworkGroupPolicyByMoid: operationId: GetFabricEthNetworkGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.EthNetworkGroupPolicy' resource. operationId: UpdateFabricEthNetworkGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.fabric.EthNetworkGroupPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.EthNetworkGroupPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkGroupPolicy' resource was modified as requested. The 'fabric.EthNetworkGroupPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' links: GetFabricEthNetworkGroupPolicyByMoid: operationId: GetFabricEthNetworkGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkGroupPolicies/{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 'fabric.EthNetworkGroupPolicy' resource is asynchronously being modified 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/fabric.EthNetworkGroupPolicy' links: GetFabricEthNetworkGroupPolicyByMoid: operationId: GetFabricEthNetworkGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.EthNetworkGroupPolicy' resource. operationId: PatchFabricEthNetworkGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.fabric.EthNetworkGroupPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.EthNetworkGroupPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkGroupPolicy' resource was patched as requested. The 'fabric.EthNetworkGroupPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' links: GetFabricEthNetworkGroupPolicyByMoid: operationId: GetFabricEthNetworkGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkGroupPolicies/{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 'fabric.EthNetworkGroupPolicy' resource is asynchronously being patched 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/fabric.EthNetworkGroupPolicy' links: GetFabricEthNetworkGroupPolicyByMoid: operationId: GetFabricEthNetworkGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.EthNetworkGroupPolicy' resource. operationId: DeleteFabricEthNetworkGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.EthNetworkGroupPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/EthNetworkPolicies: get: tags: - fabric summary: Read a 'fabric.EthNetworkPolicy' resource. operationId: GetFabricEthNetworkPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.EthNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.EthNetworkPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.EthNetworkPolicy' resource. operationId: CreateFabricEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.EthNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.EthNetworkPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkPolicy' resource was created as requested. The 'fabric.EthNetworkPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy' links: GetFabricEthNetworkPolicyByMoid: operationId: GetFabricEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkPolicies/{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 'fabric.EthNetworkPolicy' 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/fabric.EthNetworkPolicy' links: GetFabricEthNetworkPolicyByMoid: operationId: GetFabricEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/EthNetworkPolicies/{Moid}: get: tags: - fabric summary: Read a 'fabric.EthNetworkPolicy' resource. operationId: GetFabricEthNetworkPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.EthNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.EthNetworkPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricEthNetworkPolicyByMoid: operationId: GetFabricEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.EthNetworkPolicy' resource. operationId: UpdateFabricEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.EthNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.EthNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkPolicy' resource was modified as requested. The 'fabric.EthNetworkPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy' links: GetFabricEthNetworkPolicyByMoid: operationId: GetFabricEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkPolicies/{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 'fabric.EthNetworkPolicy' resource is asynchronously being modified 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/fabric.EthNetworkPolicy' links: GetFabricEthNetworkPolicyByMoid: operationId: GetFabricEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.EthNetworkPolicy' resource. operationId: PatchFabricEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.EthNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.EthNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.EthNetworkPolicy' resource was patched as requested. The 'fabric.EthNetworkPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.EthNetworkPolicy' links: GetFabricEthNetworkPolicyByMoid: operationId: GetFabricEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkPolicies/{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 'fabric.EthNetworkPolicy' resource is asynchronously being patched 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/fabric.EthNetworkPolicy' links: GetFabricEthNetworkPolicyByMoid: operationId: GetFabricEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - fabric summary: Delete a 'fabric.EthNetworkPolicy' resource. operationId: DeleteFabricEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.EthNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/FcNetworkPolicies: get: tags: - fabric summary: Read a 'fabric.FcNetworkPolicy' resource. operationId: GetFabricFcNetworkPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.FcNetworkPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.FcNetworkPolicy' resource. operationId: CreateFabricFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.FcNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.FcNetworkPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcNetworkPolicy' resource was created as requested. The 'fabric.FcNetworkPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy' links: GetFabricFcNetworkPolicyByMoid: operationId: GetFabricFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcNetworkPolicies/{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 'fabric.FcNetworkPolicy' 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/fabric.FcNetworkPolicy' links: GetFabricFcNetworkPolicyByMoid: operationId: GetFabricFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/FcNetworkPolicies/{Moid}: get: tags: - fabric summary: Read a 'fabric.FcNetworkPolicy' resource. operationId: GetFabricFcNetworkPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.FcNetworkPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricFcNetworkPolicyByMoid: operationId: GetFabricFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.FcNetworkPolicy' resource. operationId: UpdateFabricFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcNetworkPolicy' resource was modified as requested. The 'fabric.FcNetworkPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy' links: GetFabricFcNetworkPolicyByMoid: operationId: GetFabricFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcNetworkPolicies/{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 'fabric.FcNetworkPolicy' resource is asynchronously being modified 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/fabric.FcNetworkPolicy' links: GetFabricFcNetworkPolicyByMoid: operationId: GetFabricFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.FcNetworkPolicy' resource. operationId: PatchFabricFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcNetworkPolicy' resource was patched as requested. The 'fabric.FcNetworkPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcNetworkPolicy' links: GetFabricFcNetworkPolicyByMoid: operationId: GetFabricFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcNetworkPolicies/{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 'fabric.FcNetworkPolicy' resource is asynchronously being patched 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/fabric.FcNetworkPolicy' links: GetFabricFcNetworkPolicyByMoid: operationId: GetFabricFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - fabric summary: Delete a 'fabric.FcNetworkPolicy' resource. operationId: DeleteFabricFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.FcNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/FcUplinkPcRoles: get: tags: - fabric summary: Read a 'fabric.FcUplinkPcRole' resource. operationId: GetFabricFcUplinkPcRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcUplinkPcRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.FcUplinkPcRole' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.FcUplinkPcRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.FcUplinkPcRole' resource. operationId: CreateFabricFcUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.FcUplinkPcRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.FcUplinkPcRole' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkPcRole' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcUplinkPcRole' resource was created as requested. The 'fabric.FcUplinkPcRole' 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/fabric.FcUplinkPcRole' links: GetFabricFcUplinkPcRoleByMoid: operationId: GetFabricFcUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkPcRoles/{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 'fabric.FcUplinkPcRole' 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/fabric.FcUplinkPcRole' links: GetFabricFcUplinkPcRoleByMoid: operationId: GetFabricFcUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/FcUplinkPcRoles/{Moid}: get: tags: - fabric summary: Read a 'fabric.FcUplinkPcRole' resource. operationId: GetFabricFcUplinkPcRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcUplinkPcRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.FcUplinkPcRole' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkPcRole' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricFcUplinkPcRoleByMoid: operationId: GetFabricFcUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.FcUplinkPcRole' resource. operationId: UpdateFabricFcUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcUplinkPcRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcUplinkPcRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkPcRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcUplinkPcRole' resource was modified as requested. The 'fabric.FcUplinkPcRole' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkPcRole' links: GetFabricFcUplinkPcRoleByMoid: operationId: GetFabricFcUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkPcRoles/{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 'fabric.FcUplinkPcRole' resource is asynchronously being modified 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/fabric.FcUplinkPcRole' links: GetFabricFcUplinkPcRoleByMoid: operationId: GetFabricFcUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.FcUplinkPcRole' resource. operationId: PatchFabricFcUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcUplinkPcRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcUplinkPcRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkPcRole' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcUplinkPcRole' resource was patched as requested. The 'fabric.FcUplinkPcRole' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkPcRole' links: GetFabricFcUplinkPcRoleByMoid: operationId: GetFabricFcUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkPcRoles/{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 'fabric.FcUplinkPcRole' resource is asynchronously being patched 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/fabric.FcUplinkPcRole' links: GetFabricFcUplinkPcRoleByMoid: operationId: GetFabricFcUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.FcUplinkPcRole' resource. operationId: DeleteFabricFcUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.FcUplinkPcRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/FcUplinkRoles: get: tags: - fabric summary: Read a 'fabric.FcUplinkRole' resource. operationId: GetFabricFcUplinkRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcUplinkRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.FcUplinkRole' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.FcUplinkRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.FcUplinkRole' resource. operationId: CreateFabricFcUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.FcUplinkRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.FcUplinkRole' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkRole' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcUplinkRole' resource was created as requested. The 'fabric.FcUplinkRole' 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/fabric.FcUplinkRole' links: GetFabricFcUplinkRoleByMoid: operationId: GetFabricFcUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkRoles/{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 'fabric.FcUplinkRole' 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/fabric.FcUplinkRole' links: GetFabricFcUplinkRoleByMoid: operationId: GetFabricFcUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/FcUplinkRoles/{Moid}: get: tags: - fabric summary: Read a 'fabric.FcUplinkRole' resource. operationId: GetFabricFcUplinkRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcUplinkRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.FcUplinkRole' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkRole' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricFcUplinkRoleByMoid: operationId: GetFabricFcUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.FcUplinkRole' resource. operationId: UpdateFabricFcUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcUplinkRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcUplinkRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcUplinkRole' resource was modified as requested. The 'fabric.FcUplinkRole' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkRole' links: GetFabricFcUplinkRoleByMoid: operationId: GetFabricFcUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkRoles/{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 'fabric.FcUplinkRole' resource is asynchronously being modified 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/fabric.FcUplinkRole' links: GetFabricFcUplinkRoleByMoid: operationId: GetFabricFcUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.FcUplinkRole' resource. operationId: PatchFabricFcUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcUplinkRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcUplinkRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkRole' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcUplinkRole' resource was patched as requested. The 'fabric.FcUplinkRole' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcUplinkRole' links: GetFabricFcUplinkRoleByMoid: operationId: GetFabricFcUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkRoles/{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 'fabric.FcUplinkRole' resource is asynchronously being patched 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/fabric.FcUplinkRole' links: GetFabricFcUplinkRoleByMoid: operationId: GetFabricFcUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.FcUplinkRole' resource. operationId: DeleteFabricFcUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.FcUplinkRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/FcoeUplinkPcRoles: get: tags: - fabric summary: Read a 'fabric.FcoeUplinkPcRole' resource. operationId: GetFabricFcoeUplinkPcRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcoeUplinkPcRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.FcoeUplinkPcRole' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.FcoeUplinkPcRole' resource. operationId: CreateFabricFcoeUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.FcoeUplinkPcRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.FcoeUplinkPcRole' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcoeUplinkPcRole' resource was created as requested. The 'fabric.FcoeUplinkPcRole' 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/fabric.FcoeUplinkPcRole' links: GetFabricFcoeUplinkPcRoleByMoid: operationId: GetFabricFcoeUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkPcRoles/{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 'fabric.FcoeUplinkPcRole' 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/fabric.FcoeUplinkPcRole' links: GetFabricFcoeUplinkPcRoleByMoid: operationId: GetFabricFcoeUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/FcoeUplinkPcRoles/{Moid}: get: tags: - fabric summary: Read a 'fabric.FcoeUplinkPcRole' resource. operationId: GetFabricFcoeUplinkPcRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcoeUplinkPcRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.FcoeUplinkPcRole' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricFcoeUplinkPcRoleByMoid: operationId: GetFabricFcoeUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.FcoeUplinkPcRole' resource. operationId: UpdateFabricFcoeUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcoeUplinkPcRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcoeUplinkPcRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcoeUplinkPcRole' resource was modified as requested. The 'fabric.FcoeUplinkPcRole' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole' links: GetFabricFcoeUplinkPcRoleByMoid: operationId: GetFabricFcoeUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkPcRoles/{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 'fabric.FcoeUplinkPcRole' resource is asynchronously being modified 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/fabric.FcoeUplinkPcRole' links: GetFabricFcoeUplinkPcRoleByMoid: operationId: GetFabricFcoeUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.FcoeUplinkPcRole' resource. operationId: PatchFabricFcoeUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcoeUplinkPcRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcoeUplinkPcRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcoeUplinkPcRole' resource was patched as requested. The 'fabric.FcoeUplinkPcRole' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole' links: GetFabricFcoeUplinkPcRoleByMoid: operationId: GetFabricFcoeUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkPcRoles/{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 'fabric.FcoeUplinkPcRole' resource is asynchronously being patched 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/fabric.FcoeUplinkPcRole' links: GetFabricFcoeUplinkPcRoleByMoid: operationId: GetFabricFcoeUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.FcoeUplinkPcRole' resource. operationId: DeleteFabricFcoeUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.FcoeUplinkPcRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/FcoeUplinkRoles: get: tags: - fabric summary: Read a 'fabric.FcoeUplinkRole' resource. operationId: GetFabricFcoeUplinkRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcoeUplinkRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.FcoeUplinkRole' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.FcoeUplinkRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.FcoeUplinkRole' resource. operationId: CreateFabricFcoeUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.FcoeUplinkRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.FcoeUplinkRole' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkRole' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcoeUplinkRole' resource was created as requested. The 'fabric.FcoeUplinkRole' 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/fabric.FcoeUplinkRole' links: GetFabricFcoeUplinkRoleByMoid: operationId: GetFabricFcoeUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkRoles/{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 'fabric.FcoeUplinkRole' 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/fabric.FcoeUplinkRole' links: GetFabricFcoeUplinkRoleByMoid: operationId: GetFabricFcoeUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/FcoeUplinkRoles/{Moid}: get: tags: - fabric summary: Read a 'fabric.FcoeUplinkRole' resource. operationId: GetFabricFcoeUplinkRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.FcoeUplinkRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.FcoeUplinkRole' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkRole' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricFcoeUplinkRoleByMoid: operationId: GetFabricFcoeUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.FcoeUplinkRole' resource. operationId: UpdateFabricFcoeUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcoeUplinkRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcoeUplinkRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcoeUplinkRole' resource was modified as requested. The 'fabric.FcoeUplinkRole' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkRole' links: GetFabricFcoeUplinkRoleByMoid: operationId: GetFabricFcoeUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkRoles/{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 'fabric.FcoeUplinkRole' resource is asynchronously being modified 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/fabric.FcoeUplinkRole' links: GetFabricFcoeUplinkRoleByMoid: operationId: GetFabricFcoeUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.FcoeUplinkRole' resource. operationId: PatchFabricFcoeUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.FcoeUplinkRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.FcoeUplinkRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkRole' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.FcoeUplinkRole' resource was patched as requested. The 'fabric.FcoeUplinkRole' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.FcoeUplinkRole' links: GetFabricFcoeUplinkRoleByMoid: operationId: GetFabricFcoeUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkRoles/{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 'fabric.FcoeUplinkRole' resource is asynchronously being patched 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/fabric.FcoeUplinkRole' links: GetFabricFcoeUplinkRoleByMoid: operationId: GetFabricFcoeUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/FcoeUplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.FcoeUplinkRole' resource. operationId: DeleteFabricFcoeUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.FcoeUplinkRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/PcMembers: get: tags: - fabric summary: Read a 'fabric.PcMember' resource. operationId: GetFabricPcMemberList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.PcMember - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.PcMember' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.PcMember.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/PcMembers/{Moid}: get: tags: - fabric summary: Read a 'fabric.PcMember' resource. operationId: GetFabricPcMemberByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.PcMember - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.PcMember' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.PcMember' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricPcMemberByMoid: operationId: GetFabricPcMemberByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcMembers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/PcOperations: get: tags: - fabric summary: Read a 'fabric.PcOperation' resource. operationId: GetFabricPcOperationList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fabric.PcOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'fabric.PcOperation' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.PcOperation.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.PcOperation' resource. operationId: CreateFabricPcOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.PcOperation - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.PcOperation' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.PcOperation' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PcOperation' resource was created as requested. The 'fabric.PcOperation' 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/fabric.PcOperation' links: GetFabricPcOperationByMoid: operationId: GetFabricPcOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcOperations/{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 'fabric.PcOperation' 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/fabric.PcOperation' links: GetFabricPcOperationByMoid: operationId: GetFabricPcOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/PcOperations/{Moid}: get: tags: - fabric summary: Read a 'fabric.PcOperation' resource. operationId: GetFabricPcOperationByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fabric.PcOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.PcOperation' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.PcOperation' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricPcOperationByMoid: operationId: GetFabricPcOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.PcOperation' resource. operationId: UpdateFabricPcOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.fabric.PcOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PcOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PcOperation' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PcOperation' resource was modified as requested. The 'fabric.PcOperation' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PcOperation' links: GetFabricPcOperationByMoid: operationId: GetFabricPcOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcOperations/{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 'fabric.PcOperation' resource is asynchronously being modified 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/fabric.PcOperation' links: GetFabricPcOperationByMoid: operationId: GetFabricPcOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.PcOperation' resource. operationId: PatchFabricPcOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.fabric.PcOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PcOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PcOperation' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PcOperation' resource was patched as requested. The 'fabric.PcOperation' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PcOperation' links: GetFabricPcOperationByMoid: operationId: GetFabricPcOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcOperations/{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 'fabric.PcOperation' resource is asynchronously being patched 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/fabric.PcOperation' links: GetFabricPcOperationByMoid: operationId: GetFabricPcOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PcOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.PcOperation' resource. operationId: DeleteFabricPcOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.PcOperation - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/PortModes: get: tags: - fabric summary: Read a 'fabric.PortMode' resource. operationId: GetFabricPortModeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.PortMode - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.PortMode' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.PortMode.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.PortMode' resource. operationId: CreateFabricPortMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.PortMode - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.PortMode' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.PortMode' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortMode' resource was created as requested. The 'fabric.PortMode' 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/fabric.PortMode' links: GetFabricPortModeByMoid: operationId: GetFabricPortModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortModes/{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 'fabric.PortMode' 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/fabric.PortMode' links: GetFabricPortModeByMoid: operationId: GetFabricPortModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/PortModes/{Moid}: get: tags: - fabric summary: Read a 'fabric.PortMode' resource. operationId: GetFabricPortModeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.PortMode - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.PortMode' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.PortMode' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricPortModeByMoid: operationId: GetFabricPortModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.PortMode' resource. operationId: UpdateFabricPortMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.PortMode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PortMode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PortMode' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortMode' resource was modified as requested. The 'fabric.PortMode' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PortMode' links: GetFabricPortModeByMoid: operationId: GetFabricPortModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortModes/{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 'fabric.PortMode' resource is asynchronously being modified 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/fabric.PortMode' links: GetFabricPortModeByMoid: operationId: GetFabricPortModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.PortMode' resource. operationId: PatchFabricPortMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.PortMode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PortMode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PortMode' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortMode' resource was patched as requested. The 'fabric.PortMode' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PortMode' links: GetFabricPortModeByMoid: operationId: GetFabricPortModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortModes/{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 'fabric.PortMode' resource is asynchronously being patched 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/fabric.PortMode' links: GetFabricPortModeByMoid: operationId: GetFabricPortModeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortModes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.PortMode' resource. operationId: DeleteFabricPortMode security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.PortMode - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/PortOperations: get: tags: - fabric summary: Read a 'fabric.PortOperation' resource. operationId: GetFabricPortOperationList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fabric.PortOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'fabric.PortOperation' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.PortOperation.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.PortOperation' resource. operationId: CreateFabricPortOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.PortOperation - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.PortOperation' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.PortOperation' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortOperation' resource was created as requested. The 'fabric.PortOperation' 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/fabric.PortOperation' links: GetFabricPortOperationByMoid: operationId: GetFabricPortOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortOperations/{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 'fabric.PortOperation' 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/fabric.PortOperation' links: GetFabricPortOperationByMoid: operationId: GetFabricPortOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/PortOperations/{Moid}: get: tags: - fabric summary: Read a 'fabric.PortOperation' resource. operationId: GetFabricPortOperationByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fabric.PortOperation - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.PortOperation' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.PortOperation' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricPortOperationByMoid: operationId: GetFabricPortOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.PortOperation' resource. operationId: UpdateFabricPortOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.fabric.PortOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PortOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PortOperation' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortOperation' resource was modified as requested. The 'fabric.PortOperation' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PortOperation' links: GetFabricPortOperationByMoid: operationId: GetFabricPortOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortOperations/{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 'fabric.PortOperation' resource is asynchronously being modified 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/fabric.PortOperation' links: GetFabricPortOperationByMoid: operationId: GetFabricPortOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.PortOperation' resource. operationId: PatchFabricPortOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.fabric.PortOperation parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PortOperation' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PortOperation' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortOperation' resource was patched as requested. The 'fabric.PortOperation' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PortOperation' links: GetFabricPortOperationByMoid: operationId: GetFabricPortOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortOperations/{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 'fabric.PortOperation' resource is asynchronously being patched 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/fabric.PortOperation' links: GetFabricPortOperationByMoid: operationId: GetFabricPortOperationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortOperations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.PortOperation' resource. operationId: DeleteFabricPortOperation security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.PortOperation - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/PortPolicies: get: tags: - fabric summary: Read a 'fabric.PortPolicy' resource. operationId: GetFabricPortPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.PortPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.PortPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.PortPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.PortPolicy' resource. operationId: CreateFabricPortPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.PortPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.PortPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.PortPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortPolicy' resource was created as requested. The 'fabric.PortPolicy' 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/fabric.PortPolicy' links: GetFabricPortPolicyByMoid: operationId: GetFabricPortPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortPolicies/{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 'fabric.PortPolicy' 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/fabric.PortPolicy' links: GetFabricPortPolicyByMoid: operationId: GetFabricPortPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/PortPolicies/{Moid}: get: tags: - fabric summary: Read a 'fabric.PortPolicy' resource. operationId: GetFabricPortPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.PortPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.PortPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.PortPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricPortPolicyByMoid: operationId: GetFabricPortPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.PortPolicy' resource. operationId: UpdateFabricPortPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.PortPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PortPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PortPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortPolicy' resource was modified as requested. The 'fabric.PortPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PortPolicy' links: GetFabricPortPolicyByMoid: operationId: GetFabricPortPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortPolicies/{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 'fabric.PortPolicy' resource is asynchronously being modified 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/fabric.PortPolicy' links: GetFabricPortPolicyByMoid: operationId: GetFabricPortPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.PortPolicy' resource. operationId: PatchFabricPortPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.PortPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.PortPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.PortPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.PortPolicy' resource was patched as requested. The 'fabric.PortPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.PortPolicy' links: GetFabricPortPolicyByMoid: operationId: GetFabricPortPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortPolicies/{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 'fabric.PortPolicy' resource is asynchronously being patched 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/fabric.PortPolicy' links: GetFabricPortPolicyByMoid: operationId: GetFabricPortPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/PortPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.PortPolicy' resource. operationId: DeleteFabricPortPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.PortPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/ServerRoles: get: tags: - fabric summary: Read a 'fabric.ServerRole' resource. operationId: GetFabricServerRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ServerRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.ServerRole' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.ServerRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.ServerRole' resource. operationId: CreateFabricServerRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.ServerRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.ServerRole' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.ServerRole' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.ServerRole' resource was created as requested. The 'fabric.ServerRole' 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/fabric.ServerRole' links: GetFabricServerRoleByMoid: operationId: GetFabricServerRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ServerRoles/{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 'fabric.ServerRole' 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/fabric.ServerRole' links: GetFabricServerRoleByMoid: operationId: GetFabricServerRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ServerRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/ServerRoles/{Moid}: get: tags: - fabric summary: Read a 'fabric.ServerRole' resource. operationId: GetFabricServerRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.ServerRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.ServerRole' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.ServerRole' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricServerRoleByMoid: operationId: GetFabricServerRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ServerRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.ServerRole' resource. operationId: UpdateFabricServerRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.ServerRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.ServerRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.ServerRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.ServerRole' resource was modified as requested. The 'fabric.ServerRole' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.ServerRole' links: GetFabricServerRoleByMoid: operationId: GetFabricServerRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ServerRoles/{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 'fabric.ServerRole' resource is asynchronously being modified 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/fabric.ServerRole' links: GetFabricServerRoleByMoid: operationId: GetFabricServerRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ServerRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.ServerRole' resource. operationId: PatchFabricServerRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.ServerRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.ServerRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.ServerRole' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.ServerRole' resource was patched as requested. The 'fabric.ServerRole' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.ServerRole' links: GetFabricServerRoleByMoid: operationId: GetFabricServerRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ServerRoles/{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 'fabric.ServerRole' resource is asynchronously being patched 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/fabric.ServerRole' links: GetFabricServerRoleByMoid: operationId: GetFabricServerRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/ServerRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.ServerRole' resource. operationId: DeleteFabricServerRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.ServerRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/SwitchClusterProfiles: get: tags: - fabric summary: Read a 'fabric.SwitchClusterProfile' resource. operationId: GetFabricSwitchClusterProfileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.SwitchClusterProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.SwitchClusterProfile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.SwitchClusterProfile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.SwitchClusterProfile' resource. operationId: CreateFabricSwitchClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.SwitchClusterProfile - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.SwitchClusterProfile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchClusterProfile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SwitchClusterProfile' resource was created as requested. The 'fabric.SwitchClusterProfile' 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/fabric.SwitchClusterProfile' links: GetFabricSwitchClusterProfileByMoid: operationId: GetFabricSwitchClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchClusterProfiles/{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 'fabric.SwitchClusterProfile' 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/fabric.SwitchClusterProfile' links: GetFabricSwitchClusterProfileByMoid: operationId: GetFabricSwitchClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/SwitchClusterProfiles/{Moid}: get: tags: - fabric summary: Read a 'fabric.SwitchClusterProfile' resource. operationId: GetFabricSwitchClusterProfileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.SwitchClusterProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.SwitchClusterProfile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchClusterProfile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricSwitchClusterProfileByMoid: operationId: GetFabricSwitchClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.SwitchClusterProfile' resource. operationId: UpdateFabricSwitchClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.SwitchClusterProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.SwitchClusterProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.SwitchClusterProfile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SwitchClusterProfile' resource was modified as requested. The 'fabric.SwitchClusterProfile' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchClusterProfile' links: GetFabricSwitchClusterProfileByMoid: operationId: GetFabricSwitchClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchClusterProfiles/{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 'fabric.SwitchClusterProfile' resource is asynchronously being modified 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/fabric.SwitchClusterProfile' links: GetFabricSwitchClusterProfileByMoid: operationId: GetFabricSwitchClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.SwitchClusterProfile' resource. operationId: PatchFabricSwitchClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.SwitchClusterProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.SwitchClusterProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.SwitchClusterProfile' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SwitchClusterProfile' resource was patched as requested. The 'fabric.SwitchClusterProfile' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchClusterProfile' links: GetFabricSwitchClusterProfileByMoid: operationId: GetFabricSwitchClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchClusterProfiles/{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 'fabric.SwitchClusterProfile' resource is asynchronously being patched 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/fabric.SwitchClusterProfile' links: GetFabricSwitchClusterProfileByMoid: operationId: GetFabricSwitchClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.SwitchClusterProfile' resource. operationId: DeleteFabricSwitchClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.SwitchClusterProfile - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/SwitchProfiles: get: tags: - fabric summary: Read a 'fabric.SwitchProfile' resource. operationId: GetFabricSwitchProfileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.SwitchProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.SwitchProfile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.SwitchProfile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.SwitchProfile' resource. operationId: CreateFabricSwitchProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.SwitchProfile - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.SwitchProfile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchProfile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SwitchProfile' resource was created as requested. The 'fabric.SwitchProfile' 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/fabric.SwitchProfile' links: GetFabricSwitchProfileByMoid: operationId: GetFabricSwitchProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchProfiles/{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 'fabric.SwitchProfile' 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/fabric.SwitchProfile' links: GetFabricSwitchProfileByMoid: operationId: GetFabricSwitchProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/SwitchProfiles/{Moid}: get: tags: - fabric summary: Read a 'fabric.SwitchProfile' resource. operationId: GetFabricSwitchProfileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.SwitchProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.SwitchProfile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchProfile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricSwitchProfileByMoid: operationId: GetFabricSwitchProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.SwitchProfile' resource. operationId: UpdateFabricSwitchProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.SwitchProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.SwitchProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.SwitchProfile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SwitchProfile' resource was modified as requested. The 'fabric.SwitchProfile' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchProfile' links: GetFabricSwitchProfileByMoid: operationId: GetFabricSwitchProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchProfiles/{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 'fabric.SwitchProfile' resource is asynchronously being modified 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/fabric.SwitchProfile' links: GetFabricSwitchProfileByMoid: operationId: GetFabricSwitchProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.SwitchProfile' resource. operationId: PatchFabricSwitchProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.SwitchProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.SwitchProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.SwitchProfile' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SwitchProfile' resource was patched as requested. The 'fabric.SwitchProfile' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.SwitchProfile' links: GetFabricSwitchProfileByMoid: operationId: GetFabricSwitchProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchProfiles/{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 'fabric.SwitchProfile' resource is asynchronously being patched 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/fabric.SwitchProfile' links: GetFabricSwitchProfileByMoid: operationId: GetFabricSwitchProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SwitchProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.SwitchProfile' resource. operationId: DeleteFabricSwitchProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.SwitchProfile - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/SystemQosPolicies: get: tags: - fabric summary: Read a 'fabric.SystemQosPolicy' resource. operationId: GetFabricSystemQosPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.SystemQosPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.SystemQosPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.SystemQosPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.SystemQosPolicy' resource. operationId: CreateFabricSystemQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.SystemQosPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.SystemQosPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.SystemQosPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SystemQosPolicy' resource was created as requested. The 'fabric.SystemQosPolicy' 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/fabric.SystemQosPolicy' links: GetFabricSystemQosPolicyByMoid: operationId: GetFabricSystemQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SystemQosPolicies/{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 'fabric.SystemQosPolicy' 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/fabric.SystemQosPolicy' links: GetFabricSystemQosPolicyByMoid: operationId: GetFabricSystemQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SystemQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/SystemQosPolicies/{Moid}: get: tags: - fabric summary: Read a 'fabric.SystemQosPolicy' resource. operationId: GetFabricSystemQosPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.SystemQosPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.SystemQosPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.SystemQosPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricSystemQosPolicyByMoid: operationId: GetFabricSystemQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SystemQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.SystemQosPolicy' resource. operationId: UpdateFabricSystemQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.SystemQosPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.SystemQosPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.SystemQosPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SystemQosPolicy' resource was modified as requested. The 'fabric.SystemQosPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.SystemQosPolicy' links: GetFabricSystemQosPolicyByMoid: operationId: GetFabricSystemQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SystemQosPolicies/{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 'fabric.SystemQosPolicy' resource is asynchronously being modified 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/fabric.SystemQosPolicy' links: GetFabricSystemQosPolicyByMoid: operationId: GetFabricSystemQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SystemQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.SystemQosPolicy' resource. operationId: PatchFabricSystemQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.SystemQosPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.SystemQosPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.SystemQosPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.SystemQosPolicy' resource was patched as requested. The 'fabric.SystemQosPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.SystemQosPolicy' links: GetFabricSystemQosPolicyByMoid: operationId: GetFabricSystemQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SystemQosPolicies/{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 'fabric.SystemQosPolicy' resource is asynchronously being patched 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/fabric.SystemQosPolicy' links: GetFabricSystemQosPolicyByMoid: operationId: GetFabricSystemQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/SystemQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.SystemQosPolicy' resource. operationId: DeleteFabricSystemQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.SystemQosPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/UplinkPcRoles: get: tags: - fabric summary: Read a 'fabric.UplinkPcRole' resource. operationId: GetFabricUplinkPcRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.UplinkPcRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.UplinkPcRole' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.UplinkPcRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.UplinkPcRole' resource. operationId: CreateFabricUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.UplinkPcRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.UplinkPcRole' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkPcRole' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.UplinkPcRole' resource was created as requested. The 'fabric.UplinkPcRole' 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/fabric.UplinkPcRole' links: GetFabricUplinkPcRoleByMoid: operationId: GetFabricUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkPcRoles/{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 'fabric.UplinkPcRole' 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/fabric.UplinkPcRole' links: GetFabricUplinkPcRoleByMoid: operationId: GetFabricUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/UplinkPcRoles/{Moid}: get: tags: - fabric summary: Read a 'fabric.UplinkPcRole' resource. operationId: GetFabricUplinkPcRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.UplinkPcRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.UplinkPcRole' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkPcRole' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricUplinkPcRoleByMoid: operationId: GetFabricUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.UplinkPcRole' resource. operationId: UpdateFabricUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.UplinkPcRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.UplinkPcRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.UplinkPcRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.UplinkPcRole' resource was modified as requested. The 'fabric.UplinkPcRole' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkPcRole' links: GetFabricUplinkPcRoleByMoid: operationId: GetFabricUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkPcRoles/{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 'fabric.UplinkPcRole' resource is asynchronously being modified 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/fabric.UplinkPcRole' links: GetFabricUplinkPcRoleByMoid: operationId: GetFabricUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.UplinkPcRole' resource. operationId: PatchFabricUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.UplinkPcRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.UplinkPcRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.UplinkPcRole' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.UplinkPcRole' resource was patched as requested. The 'fabric.UplinkPcRole' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkPcRole' links: GetFabricUplinkPcRoleByMoid: operationId: GetFabricUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkPcRoles/{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 'fabric.UplinkPcRole' resource is asynchronously being patched 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/fabric.UplinkPcRole' links: GetFabricUplinkPcRoleByMoid: operationId: GetFabricUplinkPcRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkPcRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.UplinkPcRole' resource. operationId: DeleteFabricUplinkPcRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.UplinkPcRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/UplinkRoles: get: tags: - fabric summary: Read a 'fabric.UplinkRole' resource. operationId: GetFabricUplinkRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.UplinkRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.UplinkRole' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.UplinkRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.UplinkRole' resource. operationId: CreateFabricUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.UplinkRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.UplinkRole' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkRole' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.UplinkRole' resource was created as requested. The 'fabric.UplinkRole' 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/fabric.UplinkRole' links: GetFabricUplinkRoleByMoid: operationId: GetFabricUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkRoles/{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 'fabric.UplinkRole' 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/fabric.UplinkRole' links: GetFabricUplinkRoleByMoid: operationId: GetFabricUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/UplinkRoles/{Moid}: get: tags: - fabric summary: Read a 'fabric.UplinkRole' resource. operationId: GetFabricUplinkRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.UplinkRole - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.UplinkRole' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkRole' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricUplinkRoleByMoid: operationId: GetFabricUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.UplinkRole' resource. operationId: UpdateFabricUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.UplinkRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.UplinkRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.UplinkRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.UplinkRole' resource was modified as requested. The 'fabric.UplinkRole' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkRole' links: GetFabricUplinkRoleByMoid: operationId: GetFabricUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkRoles/{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 'fabric.UplinkRole' resource is asynchronously being modified 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/fabric.UplinkRole' links: GetFabricUplinkRoleByMoid: operationId: GetFabricUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.UplinkRole' resource. operationId: PatchFabricUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.UplinkRole parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.UplinkRole' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.UplinkRole' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.UplinkRole' resource was patched as requested. The 'fabric.UplinkRole' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.UplinkRole' links: GetFabricUplinkRoleByMoid: operationId: GetFabricUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkRoles/{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 'fabric.UplinkRole' resource is asynchronously being patched 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/fabric.UplinkRole' links: GetFabricUplinkRoleByMoid: operationId: GetFabricUplinkRoleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/UplinkRoles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.UplinkRole' resource. operationId: DeleteFabricUplinkRole security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.UplinkRole - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/Vlans: get: tags: - fabric summary: Read a 'fabric.Vlan' resource. operationId: GetFabricVlanList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.Vlan - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.Vlan' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.Vlan.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.Vlan' resource. operationId: CreateFabricVlan security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.Vlan - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.Vlan' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.Vlan' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.Vlan' resource was created as requested. The 'fabric.Vlan' 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/fabric.Vlan' links: GetFabricVlanByMoid: operationId: GetFabricVlanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vlans/{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 'fabric.Vlan' 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/fabric.Vlan' links: GetFabricVlanByMoid: operationId: GetFabricVlanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vlans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/Vlans/{Moid}: get: tags: - fabric summary: Read a 'fabric.Vlan' resource. operationId: GetFabricVlanByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.Vlan - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.Vlan' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.Vlan' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricVlanByMoid: operationId: GetFabricVlanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vlans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.Vlan' resource. operationId: UpdateFabricVlan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.Vlan parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.Vlan' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.Vlan' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.Vlan' resource was modified as requested. The 'fabric.Vlan' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.Vlan' links: GetFabricVlanByMoid: operationId: GetFabricVlanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vlans/{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 'fabric.Vlan' resource is asynchronously being modified 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/fabric.Vlan' links: GetFabricVlanByMoid: operationId: GetFabricVlanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vlans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.Vlan' resource. operationId: PatchFabricVlan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.Vlan parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.Vlan' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.Vlan' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.Vlan' resource was patched as requested. The 'fabric.Vlan' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.Vlan' links: GetFabricVlanByMoid: operationId: GetFabricVlanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vlans/{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 'fabric.Vlan' resource is asynchronously being patched 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/fabric.Vlan' links: GetFabricVlanByMoid: operationId: GetFabricVlanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vlans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.Vlan' resource. operationId: DeleteFabricVlan security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.Vlan - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fabric/Vsans: get: tags: - fabric summary: Read a 'fabric.Vsan' resource. operationId: GetFabricVsanList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.Vsan - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'fabric.Vsan' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fabric.Vsan.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Create a 'fabric.Vsan' resource. operationId: CreateFabricVsan security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fabric.Vsan - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fabric.Vsan' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fabric.Vsan' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.Vsan' resource was created as requested. The 'fabric.Vsan' 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/fabric.Vsan' links: GetFabricVsanByMoid: operationId: GetFabricVsanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vsans/{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 'fabric.Vsan' 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/fabric.Vsan' links: GetFabricVsanByMoid: operationId: GetFabricVsanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vsans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fabric/Vsans/{Moid}: get: tags: - fabric summary: Read a 'fabric.Vsan' resource. operationId: GetFabricVsanByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Switch Profiles - READ.fabric.Vsan - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fabric.Vsan' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fabric.Vsan' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFabricVsanByMoid: operationId: GetFabricVsanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vsans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fabric summary: Update a 'fabric.Vsan' resource. operationId: UpdateFabricVsan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.Vsan parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.Vsan' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.Vsan' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.Vsan' resource was modified as requested. The 'fabric.Vsan' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.Vsan' links: GetFabricVsanByMoid: operationId: GetFabricVsanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vsans/{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 'fabric.Vsan' resource is asynchronously being modified 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/fabric.Vsan' links: GetFabricVsanByMoid: operationId: GetFabricVsanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vsans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fabric summary: Update a 'fabric.Vsan' resource. operationId: PatchFabricVsan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fabric.Vsan parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fabric.Vsan' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fabric.Vsan' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fabric.Vsan' resource was patched as requested. The 'fabric.Vsan' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fabric.Vsan' links: GetFabricVsanByMoid: operationId: GetFabricVsanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vsans/{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 'fabric.Vsan' resource is asynchronously being patched 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/fabric.Vsan' links: GetFabricVsanByMoid: operationId: GetFabricVsanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fabric/Vsans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - fabric summary: Delete a 'fabric.Vsan' resource. operationId: DeleteFabricVsan security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fabric.Vsan - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/fault/Instances: get: tags: - fault summary: Read a 'fault.Instance' resource. operationId: GetFaultInstanceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.fault.Instance - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'fault.Instance' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fault.Instance.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fault/Instances/{Moid}: get: tags: - fault summary: Read a 'fault.Instance' resource. operationId: GetFaultInstanceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.fault.Instance - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fault.Instance' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fault.Instance' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFaultInstanceByMoid: operationId: GetFaultInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fault summary: Update a 'fault.Instance' resource. operationId: UpdateFaultInstance security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.fault.Instance parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fault.Instance' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fault.Instance' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fault.Instance' resource was modified as requested. The 'fault.Instance' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fault.Instance' links: GetFaultInstanceByMoid: operationId: GetFaultInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'fault.Instance' resource is asynchronously being modified 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/fault.Instance' links: GetFaultInstanceByMoid: operationId: GetFaultInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fault summary: Update a 'fault.Instance' resource. operationId: PatchFaultInstance security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.fault.Instance parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fault.Instance' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fault.Instance' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fault.Instance' resource was patched as requested. The 'fault.Instance' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fault.Instance' links: GetFaultInstanceByMoid: operationId: GetFaultInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'fault.Instance' resource is asynchronously being patched 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/fault.Instance' links: GetFaultInstanceByMoid: operationId: GetFaultInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fc/PhysicalPorts: get: tags: - fc summary: Read a 'fc.PhysicalPort' resource. operationId: GetFcPhysicalPortList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fc.PhysicalPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'fc.PhysicalPort' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fc.PhysicalPort.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fc/PhysicalPorts/{Moid}: get: tags: - fc summary: Read a 'fc.PhysicalPort' resource. operationId: GetFcPhysicalPortByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fc.PhysicalPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fc.PhysicalPort' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fc.PhysicalPort' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFcPhysicalPortByMoid: operationId: GetFcPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fc summary: Update a 'fc.PhysicalPort' resource. operationId: UpdateFcPhysicalPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.fc.PhysicalPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fc.PhysicalPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fc.PhysicalPort' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fc.PhysicalPort' resource was modified as requested. The 'fc.PhysicalPort' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fc.PhysicalPort' links: GetFcPhysicalPortByMoid: operationId: GetFcPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{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 'fc.PhysicalPort' resource is asynchronously being modified 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/fc.PhysicalPort' links: GetFcPhysicalPortByMoid: operationId: GetFcPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fc summary: Update a 'fc.PhysicalPort' resource. operationId: PatchFcPhysicalPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.fc.PhysicalPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fc.PhysicalPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fc.PhysicalPort' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fc.PhysicalPort' resource was patched as requested. The 'fc.PhysicalPort' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fc.PhysicalPort' links: GetFcPhysicalPortByMoid: operationId: GetFcPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{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 'fc.PhysicalPort' resource is asynchronously being patched 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/fc.PhysicalPort' links: GetFcPhysicalPortByMoid: operationId: GetFcPhysicalPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fc/PortChannels: get: tags: - fc summary: Read a 'fc.PortChannel' resource. operationId: GetFcPortChannelList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fc.PortChannel - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'fc.PortChannel' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fc.PortChannel.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fc/PortChannels/{Moid}: get: tags: - fc summary: Read a 'fc.PortChannel' resource. operationId: GetFcPortChannelByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.fc.PortChannel - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fc.PortChannel' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fc.PortChannel' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFcPortChannelByMoid: operationId: GetFcPortChannelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fc/PortChannels/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/FcBlocks: get: tags: - fcpool summary: Read a 'fcpool.FcBlock' resource. operationId: GetFcpoolFcBlockList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.FcBlock - 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 'fcpool.FcBlock' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fcpool.FcBlock.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/FcBlocks/{Moid}: get: tags: - fcpool summary: Read a 'fcpool.FcBlock' resource. operationId: GetFcpoolFcBlockByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.FcBlock - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fcpool.FcBlock' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fcpool.FcBlock' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFcpoolFcBlockByMoid: operationId: GetFcpoolFcBlockByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/FcBlocks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/Leases: get: tags: - fcpool summary: Read a 'fcpool.Lease' resource. operationId: GetFcpoolLeaseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.Lease - 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 'fcpool.Lease' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fcpool.Lease.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/Leases/{Moid}: get: tags: - fcpool summary: Read a 'fcpool.Lease' resource. operationId: GetFcpoolLeaseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.Lease - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fcpool.Lease' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fcpool.Lease' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFcpoolLeaseByMoid: operationId: GetFcpoolLeaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Leases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/Pools: get: tags: - fcpool summary: Read a 'fcpool.Pool' resource. operationId: GetFcpoolPoolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.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 'fcpool.Pool' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fcpool.Pool.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fcpool summary: Create a 'fcpool.Pool' resource. operationId: CreateFcpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.fcpool.Pool - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'fcpool.Pool' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/fcpool.Pool' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Pool' resource was created as requested. The 'fcpool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fcpool.Pool' links: GetFcpoolPoolByMoid: operationId: GetFcpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'fcpool.Pool' 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/fcpool.Pool' links: GetFcpoolPoolByMoid: operationId: GetFcpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/Pools/{Moid}: get: tags: - fcpool summary: Read a 'fcpool.Pool' resource. operationId: GetFcpoolPoolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.Pool - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fcpool.Pool' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fcpool.Pool' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFcpoolPoolByMoid: operationId: GetFcpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - fcpool summary: Update a 'fcpool.Pool' resource. operationId: UpdateFcpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fcpool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fcpool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fcpool.Pool' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Pool' resource was modified as requested. The 'fcpool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fcpool.Pool' links: GetFcpoolPoolByMoid: operationId: GetFcpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'fcpool.Pool' resource is asynchronously being modified 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/fcpool.Pool' links: GetFcpoolPoolByMoid: operationId: GetFcpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - fcpool summary: Update a 'fcpool.Pool' resource. operationId: PatchFcpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.fcpool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'fcpool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/fcpool.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 'fcpool.Pool' resource was patched as requested. The 'fcpool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/fcpool.Pool' links: GetFcpoolPoolByMoid: operationId: GetFcpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'fcpool.Pool' resource is asynchronously being patched 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/fcpool.Pool' links: GetFcpoolPoolByMoid: operationId: GetFcpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - fcpool summary: Delete a 'fcpool.Pool' resource. operationId: DeleteFcpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.fcpool.Pool - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/PoolMembers: get: tags: - fcpool summary: Read a 'fcpool.PoolMember' resource. operationId: GetFcpoolPoolMemberList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.PoolMember - 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 'fcpool.PoolMember' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fcpool.PoolMember.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/PoolMembers/{Moid}: get: tags: - fcpool summary: Read a 'fcpool.PoolMember' resource. operationId: GetFcpoolPoolMemberByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.PoolMember - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fcpool.PoolMember' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fcpool.PoolMember' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFcpoolPoolMemberByMoid: operationId: GetFcpoolPoolMemberByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/PoolMembers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/Universes: get: tags: - fcpool summary: Read a 'fcpool.Universe' resource. operationId: GetFcpoolUniverseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.Universe - 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 'fcpool.Universe' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/fcpool.Universe.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/fcpool/Universes/{Moid}: get: tags: - fcpool summary: Read a 'fcpool.Universe' resource. operationId: GetFcpoolUniverseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.fcpool.Universe - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'fcpool.Universe' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/fcpool.Universe' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFcpoolUniverseByMoid: operationId: GetFcpoolUniverseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Universes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/feedback/FeedbackPosts: post: tags: - feedback summary: Create a 'feedback.FeedbackPost' resource. operationId: CreateFeedbackFeedbackPost security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.feedback.FeedbackPost 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'feedback.FeedbackPost' 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/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/firmware/BiosDescriptors: get: tags: - firmware summary: Read a 'firmware.BiosDescriptor' resource. operationId: GetFirmwareBiosDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.BiosDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.BiosDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.BiosDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.BiosDescriptor' resource. operationId: CreateFirmwareBiosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.BiosDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.BiosDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.BiosDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.BiosDescriptor' resource was created as requested. The 'firmware.BiosDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.BiosDescriptor' links: GetFirmwareBiosDescriptorByMoid: operationId: GetFirmwareBiosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.BiosDescriptor' 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/firmware.BiosDescriptor' links: GetFirmwareBiosDescriptorByMoid: operationId: GetFirmwareBiosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/BiosDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.BiosDescriptor' resource. operationId: GetFirmwareBiosDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.BiosDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.BiosDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.BiosDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareBiosDescriptorByMoid: operationId: GetFirmwareBiosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.BiosDescriptor' resource. operationId: UpdateFirmwareBiosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.BiosDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.BiosDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.BiosDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.BiosDescriptor' resource was modified as requested. The 'firmware.BiosDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.BiosDescriptor' links: GetFirmwareBiosDescriptorByMoid: operationId: GetFirmwareBiosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.BiosDescriptor' resource is asynchronously being modified 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/firmware.BiosDescriptor' links: GetFirmwareBiosDescriptorByMoid: operationId: GetFirmwareBiosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.BiosDescriptor' resource. operationId: PatchFirmwareBiosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.BiosDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.BiosDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.BiosDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.BiosDescriptor' resource was patched as requested. The 'firmware.BiosDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.BiosDescriptor' links: GetFirmwareBiosDescriptorByMoid: operationId: GetFirmwareBiosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.BiosDescriptor' resource is asynchronously being patched 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/firmware.BiosDescriptor' links: GetFirmwareBiosDescriptorByMoid: operationId: GetFirmwareBiosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.BiosDescriptor' resource. operationId: DeleteFirmwareBiosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.BiosDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/BoardControllerDescriptors: get: tags: - firmware summary: Read a 'firmware.BoardControllerDescriptor' resource. operationId: GetFirmwareBoardControllerDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.BoardControllerDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.BoardControllerDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.BoardControllerDescriptor' resource. operationId: CreateFirmwareBoardControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.BoardControllerDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.BoardControllerDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.BoardControllerDescriptor' resource was created as requested. The 'firmware.BoardControllerDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' links: GetFirmwareBoardControllerDescriptorByMoid: operationId: GetFirmwareBoardControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.BoardControllerDescriptor' 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/firmware.BoardControllerDescriptor' links: GetFirmwareBoardControllerDescriptorByMoid: operationId: GetFirmwareBoardControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/BoardControllerDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.BoardControllerDescriptor' resource. operationId: GetFirmwareBoardControllerDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.BoardControllerDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.BoardControllerDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareBoardControllerDescriptorByMoid: operationId: GetFirmwareBoardControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.BoardControllerDescriptor' resource. operationId: UpdateFirmwareBoardControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.BoardControllerDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.BoardControllerDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.BoardControllerDescriptor' resource was modified as requested. The 'firmware.BoardControllerDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' links: GetFirmwareBoardControllerDescriptorByMoid: operationId: GetFirmwareBoardControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.BoardControllerDescriptor' resource is asynchronously being modified 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/firmware.BoardControllerDescriptor' links: GetFirmwareBoardControllerDescriptorByMoid: operationId: GetFirmwareBoardControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.BoardControllerDescriptor' resource. operationId: PatchFirmwareBoardControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.BoardControllerDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.BoardControllerDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.BoardControllerDescriptor' resource was patched as requested. The 'firmware.BoardControllerDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' links: GetFirmwareBoardControllerDescriptorByMoid: operationId: GetFirmwareBoardControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.BoardControllerDescriptor' resource is asynchronously being patched 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/firmware.BoardControllerDescriptor' links: GetFirmwareBoardControllerDescriptorByMoid: operationId: GetFirmwareBoardControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.BoardControllerDescriptor' resource. operationId: DeleteFirmwareBoardControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.BoardControllerDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/ChassisUpgrades: get: tags: - firmware summary: Read a 'firmware.ChassisUpgrade' resource. operationId: GetFirmwareChassisUpgradeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.firmware.ChassisUpgrade - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'firmware.ChassisUpgrade' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.ChassisUpgrade.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.ChassisUpgrade' resource. operationId: CreateFirmwareChassisUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.ChassisUpgrade - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.ChassisUpgrade' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.ChassisUpgrade' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ChassisUpgrade' resource was created as requested. The 'firmware.ChassisUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.ChassisUpgrade' links: GetFirmwareChassisUpgradeByMoid: operationId: GetFirmwareChassisUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ChassisUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.ChassisUpgrade' 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/firmware.ChassisUpgrade' links: GetFirmwareChassisUpgradeByMoid: operationId: GetFirmwareChassisUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ChassisUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/ChassisUpgrades/{Moid}: get: tags: - firmware summary: Read a 'firmware.ChassisUpgrade' resource. operationId: GetFirmwareChassisUpgradeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.firmware.ChassisUpgrade - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.ChassisUpgrade' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.ChassisUpgrade' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareChassisUpgradeByMoid: operationId: GetFirmwareChassisUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ChassisUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.ChassisUpgrade' resource. operationId: DeleteFirmwareChassisUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.ChassisUpgrade - PRIVSET.Account Administrator - PRIVSET.Manage Servers - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/CimcDescriptors: get: tags: - firmware summary: Read a 'firmware.CimcDescriptor' resource. operationId: GetFirmwareCimcDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.CimcDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.CimcDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.CimcDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.CimcDescriptor' resource. operationId: CreateFirmwareCimcDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.CimcDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.CimcDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.CimcDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.CimcDescriptor' resource was created as requested. The 'firmware.CimcDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.CimcDescriptor' links: GetFirmwareCimcDescriptorByMoid: operationId: GetFirmwareCimcDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.CimcDescriptor' 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/firmware.CimcDescriptor' links: GetFirmwareCimcDescriptorByMoid: operationId: GetFirmwareCimcDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/CimcDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.CimcDescriptor' resource. operationId: GetFirmwareCimcDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.CimcDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.CimcDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.CimcDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareCimcDescriptorByMoid: operationId: GetFirmwareCimcDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.CimcDescriptor' resource. operationId: UpdateFirmwareCimcDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.CimcDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.CimcDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.CimcDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.CimcDescriptor' resource was modified as requested. The 'firmware.CimcDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.CimcDescriptor' links: GetFirmwareCimcDescriptorByMoid: operationId: GetFirmwareCimcDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.CimcDescriptor' resource is asynchronously being modified 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/firmware.CimcDescriptor' links: GetFirmwareCimcDescriptorByMoid: operationId: GetFirmwareCimcDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.CimcDescriptor' resource. operationId: PatchFirmwareCimcDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.CimcDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.CimcDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.CimcDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.CimcDescriptor' resource was patched as requested. The 'firmware.CimcDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.CimcDescriptor' links: GetFirmwareCimcDescriptorByMoid: operationId: GetFirmwareCimcDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.CimcDescriptor' resource is asynchronously being patched 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/firmware.CimcDescriptor' links: GetFirmwareCimcDescriptorByMoid: operationId: GetFirmwareCimcDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.CimcDescriptor' resource. operationId: DeleteFirmwareCimcDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.CimcDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DimmDescriptors: get: tags: - firmware summary: Read a 'firmware.DimmDescriptor' resource. operationId: GetFirmwareDimmDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.DimmDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.DimmDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.DimmDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.DimmDescriptor' resource. operationId: CreateFirmwareDimmDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.DimmDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.DimmDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.DimmDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DimmDescriptor' resource was created as requested. The 'firmware.DimmDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DimmDescriptor' links: GetFirmwareDimmDescriptorByMoid: operationId: GetFirmwareDimmDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DimmDescriptor' 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/firmware.DimmDescriptor' links: GetFirmwareDimmDescriptorByMoid: operationId: GetFirmwareDimmDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DimmDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.DimmDescriptor' resource. operationId: GetFirmwareDimmDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.DimmDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.DimmDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.DimmDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareDimmDescriptorByMoid: operationId: GetFirmwareDimmDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.DimmDescriptor' resource. operationId: UpdateFirmwareDimmDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.DimmDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.DimmDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.DimmDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DimmDescriptor' resource was modified as requested. The 'firmware.DimmDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DimmDescriptor' links: GetFirmwareDimmDescriptorByMoid: operationId: GetFirmwareDimmDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DimmDescriptor' resource is asynchronously being modified 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/firmware.DimmDescriptor' links: GetFirmwareDimmDescriptorByMoid: operationId: GetFirmwareDimmDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.DimmDescriptor' resource. operationId: PatchFirmwareDimmDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.DimmDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.DimmDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.DimmDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DimmDescriptor' resource was patched as requested. The 'firmware.DimmDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DimmDescriptor' links: GetFirmwareDimmDescriptorByMoid: operationId: GetFirmwareDimmDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DimmDescriptor' resource is asynchronously being patched 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/firmware.DimmDescriptor' links: GetFirmwareDimmDescriptorByMoid: operationId: GetFirmwareDimmDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.DimmDescriptor' resource. operationId: DeleteFirmwareDimmDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.DimmDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/Distributables: get: tags: - firmware summary: Read a 'firmware.Distributable' resource. operationId: GetFirmwareDistributableList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.Distributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.Distributable' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.Distributable.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.Distributable' resource. operationId: CreateFirmwareDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.Distributable - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.Distributable' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.Distributable' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Distributable' resource was created as requested. The 'firmware.Distributable' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.Distributable' links: GetFirmwareDistributableByMoid: operationId: GetFirmwareDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.Distributable' 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/firmware.Distributable' links: GetFirmwareDistributableByMoid: operationId: GetFirmwareDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/Distributables/{Moid}: get: tags: - firmware summary: Read a 'firmware.Distributable' resource. operationId: GetFirmwareDistributableByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.Distributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.Distributable' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.Distributable' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareDistributableByMoid: operationId: GetFirmwareDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.Distributable' resource. operationId: UpdateFirmwareDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.Distributable parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.Distributable' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.Distributable' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Distributable' resource was modified as requested. The 'firmware.Distributable' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.Distributable' links: GetFirmwareDistributableByMoid: operationId: GetFirmwareDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.Distributable' resource is asynchronously being modified 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/firmware.Distributable' links: GetFirmwareDistributableByMoid: operationId: GetFirmwareDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.Distributable' resource. operationId: PatchFirmwareDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.Distributable parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.Distributable' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.Distributable' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Distributable' resource was patched as requested. The 'firmware.Distributable' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.Distributable' links: GetFirmwareDistributableByMoid: operationId: GetFirmwareDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.Distributable' resource is asynchronously being patched 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/firmware.Distributable' links: GetFirmwareDistributableByMoid: operationId: GetFirmwareDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.Distributable' resource. operationId: DeleteFirmwareDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.Distributable - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DistributableMeta: get: tags: - firmware summary: Read a 'firmware.DistributableMeta' resource. operationId: GetFirmwareDistributableMetaList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.DistributableMeta - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.DistributableMeta' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.DistributableMeta.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DistributableMeta/{Moid}: get: tags: - firmware summary: Read a 'firmware.DistributableMeta' resource. operationId: GetFirmwareDistributableMetaByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.DistributableMeta - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.DistributableMeta' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.DistributableMeta' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareDistributableMetaByMoid: operationId: GetFirmwareDistributableMetaByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DistributableMeta/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DriveDescriptors: get: tags: - firmware summary: Read a 'firmware.DriveDescriptor' resource. operationId: GetFirmwareDriveDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.DriveDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.DriveDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.DriveDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.DriveDescriptor' resource. operationId: CreateFirmwareDriveDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.DriveDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.DriveDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.DriveDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriveDescriptor' resource was created as requested. The 'firmware.DriveDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DriveDescriptor' links: GetFirmwareDriveDescriptorByMoid: operationId: GetFirmwareDriveDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DriveDescriptor' 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/firmware.DriveDescriptor' links: GetFirmwareDriveDescriptorByMoid: operationId: GetFirmwareDriveDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DriveDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.DriveDescriptor' resource. operationId: GetFirmwareDriveDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.DriveDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.DriveDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.DriveDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareDriveDescriptorByMoid: operationId: GetFirmwareDriveDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.DriveDescriptor' resource. operationId: UpdateFirmwareDriveDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.DriveDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.DriveDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.DriveDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriveDescriptor' resource was modified as requested. The 'firmware.DriveDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DriveDescriptor' links: GetFirmwareDriveDescriptorByMoid: operationId: GetFirmwareDriveDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DriveDescriptor' resource is asynchronously being modified 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/firmware.DriveDescriptor' links: GetFirmwareDriveDescriptorByMoid: operationId: GetFirmwareDriveDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.DriveDescriptor' resource. operationId: PatchFirmwareDriveDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.DriveDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.DriveDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.DriveDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriveDescriptor' resource was patched as requested. The 'firmware.DriveDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DriveDescriptor' links: GetFirmwareDriveDescriptorByMoid: operationId: GetFirmwareDriveDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DriveDescriptor' resource is asynchronously being patched 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/firmware.DriveDescriptor' links: GetFirmwareDriveDescriptorByMoid: operationId: GetFirmwareDriveDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.DriveDescriptor' resource. operationId: DeleteFirmwareDriveDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.DriveDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DriverDistributables: post: tags: - firmware summary: Create a 'firmware.DriverDistributable' resource. operationId: CreateFirmwareDriverDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.DriverDistributable - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.DriverDistributable' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.DriverDistributable' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriverDistributable' resource was created as requested. The 'firmware.DriverDistributable' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DriverDistributable' links: GetFirmwareDriverDistributableByMoid: operationId: GetFirmwareDriverDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DriverDistributable' 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/firmware.DriverDistributable' links: GetFirmwareDriverDistributableByMoid: operationId: GetFirmwareDriverDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - firmware summary: Read a 'firmware.DriverDistributable' resource. operationId: GetFirmwareDriverDistributableList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.DriverDistributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.DriverDistributable' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.DriverDistributable.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/DriverDistributables/{Moid}: post: tags: - firmware summary: Update a 'firmware.DriverDistributable' resource. operationId: UpdateFirmwareDriverDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.DriverDistributable parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.DriverDistributable' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.DriverDistributable' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriverDistributable' resource was modified as requested. The 'firmware.DriverDistributable' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DriverDistributable' links: GetFirmwareDriverDistributableByMoid: operationId: GetFirmwareDriverDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DriverDistributable' resource is asynchronously being modified 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/firmware.DriverDistributable' links: GetFirmwareDriverDistributableByMoid: operationId: GetFirmwareDriverDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.DriverDistributable' resource. operationId: PatchFirmwareDriverDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.DriverDistributable parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.DriverDistributable' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.DriverDistributable' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriverDistributable' resource was patched as requested. The 'firmware.DriverDistributable' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.DriverDistributable' links: GetFirmwareDriverDistributableByMoid: operationId: GetFirmwareDriverDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.DriverDistributable' resource is asynchronously being patched 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/firmware.DriverDistributable' links: GetFirmwareDriverDistributableByMoid: operationId: GetFirmwareDriverDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - firmware summary: Read a 'firmware.DriverDistributable' resource. operationId: GetFirmwareDriverDistributableByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.DriverDistributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.DriverDistributable' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.DriverDistributable' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareDriverDistributableByMoid: operationId: GetFirmwareDriverDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.DriverDistributable' resource. operationId: DeleteFirmwareDriverDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.DriverDistributable - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/Eulas: post: tags: - firmware summary: Create a 'firmware.Eula' resource. operationId: CreateFirmwareEula security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.Eula - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.Eula' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.Eula' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Eula' resource was created as requested. The 'firmware.Eula' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.Eula' links: GetFirmwareEulaByMoid: operationId: GetFirmwareEulaByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.Eula' 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/firmware.Eula' links: GetFirmwareEulaByMoid: operationId: GetFirmwareEulaByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - firmware summary: Read a 'firmware.Eula' resource. operationId: GetFirmwareEulaList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.Eula - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.Eula' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.Eula.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/Eulas/{Moid}: get: tags: - firmware summary: Read a 'firmware.Eula' resource. operationId: GetFirmwareEulaByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.Eula - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.Eula' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.Eula' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareEulaByMoid: operationId: GetFirmwareEulaByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/FirmwareSummaries: get: tags: - firmware summary: Read a 'firmware.FirmwareSummary' resource. operationId: GetFirmwareFirmwareSummaryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.firmware.FirmwareSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'firmware.FirmwareSummary' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.FirmwareSummary.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/FirmwareSummaries/{Moid}: get: tags: - firmware summary: Read a 'firmware.FirmwareSummary' resource. operationId: GetFirmwareFirmwareSummaryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.firmware.FirmwareSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.FirmwareSummary' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.FirmwareSummary' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareFirmwareSummaryByMoid: operationId: GetFirmwareFirmwareSummaryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/FirmwareSummaries/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/GpuDescriptors: get: tags: - firmware summary: Read a 'firmware.GpuDescriptor' resource. operationId: GetFirmwareGpuDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.GpuDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.GpuDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.GpuDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.GpuDescriptor' resource. operationId: CreateFirmwareGpuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.GpuDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.GpuDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.GpuDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.GpuDescriptor' resource was created as requested. The 'firmware.GpuDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.GpuDescriptor' links: GetFirmwareGpuDescriptorByMoid: operationId: GetFirmwareGpuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.GpuDescriptor' 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/firmware.GpuDescriptor' links: GetFirmwareGpuDescriptorByMoid: operationId: GetFirmwareGpuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/GpuDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.GpuDescriptor' resource. operationId: GetFirmwareGpuDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.GpuDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.GpuDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.GpuDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareGpuDescriptorByMoid: operationId: GetFirmwareGpuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.GpuDescriptor' resource. operationId: UpdateFirmwareGpuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.GpuDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.GpuDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.GpuDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.GpuDescriptor' resource was modified as requested. The 'firmware.GpuDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.GpuDescriptor' links: GetFirmwareGpuDescriptorByMoid: operationId: GetFirmwareGpuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.GpuDescriptor' resource is asynchronously being modified 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/firmware.GpuDescriptor' links: GetFirmwareGpuDescriptorByMoid: operationId: GetFirmwareGpuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.GpuDescriptor' resource. operationId: PatchFirmwareGpuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.GpuDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.GpuDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.GpuDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.GpuDescriptor' resource was patched as requested. The 'firmware.GpuDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.GpuDescriptor' links: GetFirmwareGpuDescriptorByMoid: operationId: GetFirmwareGpuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.GpuDescriptor' resource is asynchronously being patched 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/firmware.GpuDescriptor' links: GetFirmwareGpuDescriptorByMoid: operationId: GetFirmwareGpuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.GpuDescriptor' resource. operationId: DeleteFirmwareGpuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.GpuDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/HbaDescriptors: get: tags: - firmware summary: Read a 'firmware.HbaDescriptor' resource. operationId: GetFirmwareHbaDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.HbaDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.HbaDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.HbaDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.HbaDescriptor' resource. operationId: CreateFirmwareHbaDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.HbaDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.HbaDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.HbaDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.HbaDescriptor' resource was created as requested. The 'firmware.HbaDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.HbaDescriptor' links: GetFirmwareHbaDescriptorByMoid: operationId: GetFirmwareHbaDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.HbaDescriptor' 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/firmware.HbaDescriptor' links: GetFirmwareHbaDescriptorByMoid: operationId: GetFirmwareHbaDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/HbaDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.HbaDescriptor' resource. operationId: GetFirmwareHbaDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.HbaDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.HbaDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.HbaDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareHbaDescriptorByMoid: operationId: GetFirmwareHbaDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.HbaDescriptor' resource. operationId: UpdateFirmwareHbaDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.HbaDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.HbaDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.HbaDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.HbaDescriptor' resource was modified as requested. The 'firmware.HbaDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.HbaDescriptor' links: GetFirmwareHbaDescriptorByMoid: operationId: GetFirmwareHbaDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.HbaDescriptor' resource is asynchronously being modified 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/firmware.HbaDescriptor' links: GetFirmwareHbaDescriptorByMoid: operationId: GetFirmwareHbaDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.HbaDescriptor' resource. operationId: PatchFirmwareHbaDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.HbaDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.HbaDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.HbaDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.HbaDescriptor' resource was patched as requested. The 'firmware.HbaDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.HbaDescriptor' links: GetFirmwareHbaDescriptorByMoid: operationId: GetFirmwareHbaDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.HbaDescriptor' resource is asynchronously being patched 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/firmware.HbaDescriptor' links: GetFirmwareHbaDescriptorByMoid: operationId: GetFirmwareHbaDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.HbaDescriptor' resource. operationId: DeleteFirmwareHbaDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.HbaDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/IomDescriptors: get: tags: - firmware summary: Read a 'firmware.IomDescriptor' resource. operationId: GetFirmwareIomDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.IomDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.IomDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.IomDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.IomDescriptor' resource. operationId: CreateFirmwareIomDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.IomDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.IomDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.IomDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.IomDescriptor' resource was created as requested. The 'firmware.IomDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.IomDescriptor' links: GetFirmwareIomDescriptorByMoid: operationId: GetFirmwareIomDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.IomDescriptor' 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/firmware.IomDescriptor' links: GetFirmwareIomDescriptorByMoid: operationId: GetFirmwareIomDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/IomDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.IomDescriptor' resource. operationId: GetFirmwareIomDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.IomDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.IomDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.IomDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareIomDescriptorByMoid: operationId: GetFirmwareIomDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.IomDescriptor' resource. operationId: UpdateFirmwareIomDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.IomDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.IomDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.IomDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.IomDescriptor' resource was modified as requested. The 'firmware.IomDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.IomDescriptor' links: GetFirmwareIomDescriptorByMoid: operationId: GetFirmwareIomDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.IomDescriptor' resource is asynchronously being modified 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/firmware.IomDescriptor' links: GetFirmwareIomDescriptorByMoid: operationId: GetFirmwareIomDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.IomDescriptor' resource. operationId: PatchFirmwareIomDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.IomDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.IomDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.IomDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.IomDescriptor' resource was patched as requested. The 'firmware.IomDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.IomDescriptor' links: GetFirmwareIomDescriptorByMoid: operationId: GetFirmwareIomDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.IomDescriptor' resource is asynchronously being patched 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/firmware.IomDescriptor' links: GetFirmwareIomDescriptorByMoid: operationId: GetFirmwareIomDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.IomDescriptor' resource. operationId: DeleteFirmwareIomDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.IomDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/MswitchDescriptors: get: tags: - firmware summary: Read a 'firmware.MswitchDescriptor' resource. operationId: GetFirmwareMswitchDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.MswitchDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.MswitchDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.MswitchDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.MswitchDescriptor' resource. operationId: CreateFirmwareMswitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.MswitchDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.MswitchDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.MswitchDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.MswitchDescriptor' resource was created as requested. The 'firmware.MswitchDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.MswitchDescriptor' links: GetFirmwareMswitchDescriptorByMoid: operationId: GetFirmwareMswitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.MswitchDescriptor' 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/firmware.MswitchDescriptor' links: GetFirmwareMswitchDescriptorByMoid: operationId: GetFirmwareMswitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/MswitchDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.MswitchDescriptor' resource. operationId: GetFirmwareMswitchDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.MswitchDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.MswitchDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.MswitchDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareMswitchDescriptorByMoid: operationId: GetFirmwareMswitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.MswitchDescriptor' resource. operationId: UpdateFirmwareMswitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.MswitchDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.MswitchDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.MswitchDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.MswitchDescriptor' resource was modified as requested. The 'firmware.MswitchDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.MswitchDescriptor' links: GetFirmwareMswitchDescriptorByMoid: operationId: GetFirmwareMswitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.MswitchDescriptor' resource is asynchronously being modified 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/firmware.MswitchDescriptor' links: GetFirmwareMswitchDescriptorByMoid: operationId: GetFirmwareMswitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.MswitchDescriptor' resource. operationId: PatchFirmwareMswitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.MswitchDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.MswitchDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.MswitchDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.MswitchDescriptor' resource was patched as requested. The 'firmware.MswitchDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.MswitchDescriptor' links: GetFirmwareMswitchDescriptorByMoid: operationId: GetFirmwareMswitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.MswitchDescriptor' resource is asynchronously being patched 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/firmware.MswitchDescriptor' links: GetFirmwareMswitchDescriptorByMoid: operationId: GetFirmwareMswitchDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.MswitchDescriptor' resource. operationId: DeleteFirmwareMswitchDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.MswitchDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/NxosDescriptors: get: tags: - firmware summary: Read a 'firmware.NxosDescriptor' resource. operationId: GetFirmwareNxosDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.NxosDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.NxosDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.NxosDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.NxosDescriptor' resource. operationId: CreateFirmwareNxosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.NxosDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.NxosDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.NxosDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.NxosDescriptor' resource was created as requested. The 'firmware.NxosDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.NxosDescriptor' links: GetFirmwareNxosDescriptorByMoid: operationId: GetFirmwareNxosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.NxosDescriptor' 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/firmware.NxosDescriptor' links: GetFirmwareNxosDescriptorByMoid: operationId: GetFirmwareNxosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/NxosDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.NxosDescriptor' resource. operationId: GetFirmwareNxosDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.NxosDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.NxosDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.NxosDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareNxosDescriptorByMoid: operationId: GetFirmwareNxosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.NxosDescriptor' resource. operationId: UpdateFirmwareNxosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.NxosDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.NxosDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.NxosDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.NxosDescriptor' resource was modified as requested. The 'firmware.NxosDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.NxosDescriptor' links: GetFirmwareNxosDescriptorByMoid: operationId: GetFirmwareNxosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.NxosDescriptor' resource is asynchronously being modified 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/firmware.NxosDescriptor' links: GetFirmwareNxosDescriptorByMoid: operationId: GetFirmwareNxosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.NxosDescriptor' resource. operationId: PatchFirmwareNxosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.NxosDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.NxosDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.NxosDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.NxosDescriptor' resource was patched as requested. The 'firmware.NxosDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.NxosDescriptor' links: GetFirmwareNxosDescriptorByMoid: operationId: GetFirmwareNxosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.NxosDescriptor' resource is asynchronously being patched 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/firmware.NxosDescriptor' links: GetFirmwareNxosDescriptorByMoid: operationId: GetFirmwareNxosDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.NxosDescriptor' resource. operationId: DeleteFirmwareNxosDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.NxosDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/PcieDescriptors: get: tags: - firmware summary: Read a 'firmware.PcieDescriptor' resource. operationId: GetFirmwarePcieDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.PcieDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.PcieDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.PcieDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.PcieDescriptor' resource. operationId: CreateFirmwarePcieDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.PcieDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.PcieDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.PcieDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.PcieDescriptor' resource was created as requested. The 'firmware.PcieDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.PcieDescriptor' links: GetFirmwarePcieDescriptorByMoid: operationId: GetFirmwarePcieDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.PcieDescriptor' 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/firmware.PcieDescriptor' links: GetFirmwarePcieDescriptorByMoid: operationId: GetFirmwarePcieDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/PcieDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.PcieDescriptor' resource. operationId: GetFirmwarePcieDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.PcieDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.PcieDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.PcieDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwarePcieDescriptorByMoid: operationId: GetFirmwarePcieDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.PcieDescriptor' resource. operationId: UpdateFirmwarePcieDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.PcieDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.PcieDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.PcieDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.PcieDescriptor' resource was modified as requested. The 'firmware.PcieDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.PcieDescriptor' links: GetFirmwarePcieDescriptorByMoid: operationId: GetFirmwarePcieDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.PcieDescriptor' resource is asynchronously being modified 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/firmware.PcieDescriptor' links: GetFirmwarePcieDescriptorByMoid: operationId: GetFirmwarePcieDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.PcieDescriptor' resource. operationId: PatchFirmwarePcieDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.PcieDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.PcieDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.PcieDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.PcieDescriptor' resource was patched as requested. The 'firmware.PcieDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.PcieDescriptor' links: GetFirmwarePcieDescriptorByMoid: operationId: GetFirmwarePcieDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.PcieDescriptor' resource is asynchronously being patched 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/firmware.PcieDescriptor' links: GetFirmwarePcieDescriptorByMoid: operationId: GetFirmwarePcieDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.PcieDescriptor' resource. operationId: DeleteFirmwarePcieDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.PcieDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/PsuDescriptors: get: tags: - firmware summary: Read a 'firmware.PsuDescriptor' resource. operationId: GetFirmwarePsuDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.PsuDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.PsuDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.PsuDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.PsuDescriptor' resource. operationId: CreateFirmwarePsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.PsuDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.PsuDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.PsuDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.PsuDescriptor' resource was created as requested. The 'firmware.PsuDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.PsuDescriptor' links: GetFirmwarePsuDescriptorByMoid: operationId: GetFirmwarePsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.PsuDescriptor' 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/firmware.PsuDescriptor' links: GetFirmwarePsuDescriptorByMoid: operationId: GetFirmwarePsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/PsuDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.PsuDescriptor' resource. operationId: GetFirmwarePsuDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.PsuDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.PsuDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.PsuDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwarePsuDescriptorByMoid: operationId: GetFirmwarePsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.PsuDescriptor' resource. operationId: UpdateFirmwarePsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.PsuDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.PsuDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.PsuDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.PsuDescriptor' resource was modified as requested. The 'firmware.PsuDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.PsuDescriptor' links: GetFirmwarePsuDescriptorByMoid: operationId: GetFirmwarePsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.PsuDescriptor' resource is asynchronously being modified 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/firmware.PsuDescriptor' links: GetFirmwarePsuDescriptorByMoid: operationId: GetFirmwarePsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.PsuDescriptor' resource. operationId: PatchFirmwarePsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.PsuDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.PsuDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.PsuDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.PsuDescriptor' resource was patched as requested. The 'firmware.PsuDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.PsuDescriptor' links: GetFirmwarePsuDescriptorByMoid: operationId: GetFirmwarePsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.PsuDescriptor' resource is asynchronously being patched 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/firmware.PsuDescriptor' links: GetFirmwarePsuDescriptorByMoid: operationId: GetFirmwarePsuDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.PsuDescriptor' resource. operationId: DeleteFirmwarePsuDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.PsuDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/RunningFirmwares: get: tags: - firmware summary: Read a 'firmware.RunningFirmware' resource. operationId: GetFirmwareRunningFirmwareList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.firmware.RunningFirmware - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'firmware.RunningFirmware' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.RunningFirmware.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/RunningFirmwares/{Moid}: get: tags: - firmware summary: Read a 'firmware.RunningFirmware' resource. operationId: GetFirmwareRunningFirmwareByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.firmware.RunningFirmware - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.RunningFirmware' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.RunningFirmware' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareRunningFirmwareByMoid: operationId: GetFirmwareRunningFirmwareByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.RunningFirmware' resource. operationId: UpdateFirmwareRunningFirmware security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.RunningFirmware parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.RunningFirmware' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.RunningFirmware' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.RunningFirmware' resource was modified as requested. The 'firmware.RunningFirmware' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.RunningFirmware' links: GetFirmwareRunningFirmwareByMoid: operationId: GetFirmwareRunningFirmwareByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.RunningFirmware' resource is asynchronously being modified 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/firmware.RunningFirmware' links: GetFirmwareRunningFirmwareByMoid: operationId: GetFirmwareRunningFirmwareByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.RunningFirmware' resource. operationId: PatchFirmwareRunningFirmware security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.RunningFirmware parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.RunningFirmware' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.RunningFirmware' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.RunningFirmware' resource was patched as requested. The 'firmware.RunningFirmware' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.RunningFirmware' links: GetFirmwareRunningFirmwareByMoid: operationId: GetFirmwareRunningFirmwareByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.RunningFirmware' resource is asynchronously being patched 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/firmware.RunningFirmware' links: GetFirmwareRunningFirmwareByMoid: operationId: GetFirmwareRunningFirmwareByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/SasExpanderDescriptors: get: tags: - firmware summary: Read a 'firmware.SasExpanderDescriptor' resource. operationId: GetFirmwareSasExpanderDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.SasExpanderDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.SasExpanderDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.SasExpanderDescriptor' resource. operationId: CreateFirmwareSasExpanderDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.SasExpanderDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.SasExpanderDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.SasExpanderDescriptor' resource was created as requested. The 'firmware.SasExpanderDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' links: GetFirmwareSasExpanderDescriptorByMoid: operationId: GetFirmwareSasExpanderDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.SasExpanderDescriptor' 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/firmware.SasExpanderDescriptor' links: GetFirmwareSasExpanderDescriptorByMoid: operationId: GetFirmwareSasExpanderDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/SasExpanderDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.SasExpanderDescriptor' resource. operationId: GetFirmwareSasExpanderDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.SasExpanderDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.SasExpanderDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareSasExpanderDescriptorByMoid: operationId: GetFirmwareSasExpanderDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.SasExpanderDescriptor' resource. operationId: UpdateFirmwareSasExpanderDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.SasExpanderDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.SasExpanderDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.SasExpanderDescriptor' resource was modified as requested. The 'firmware.SasExpanderDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' links: GetFirmwareSasExpanderDescriptorByMoid: operationId: GetFirmwareSasExpanderDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.SasExpanderDescriptor' resource is asynchronously being modified 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/firmware.SasExpanderDescriptor' links: GetFirmwareSasExpanderDescriptorByMoid: operationId: GetFirmwareSasExpanderDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.SasExpanderDescriptor' resource. operationId: PatchFirmwareSasExpanderDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.SasExpanderDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.SasExpanderDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.SasExpanderDescriptor' resource was patched as requested. The 'firmware.SasExpanderDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' links: GetFirmwareSasExpanderDescriptorByMoid: operationId: GetFirmwareSasExpanderDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.SasExpanderDescriptor' resource is asynchronously being patched 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/firmware.SasExpanderDescriptor' links: GetFirmwareSasExpanderDescriptorByMoid: operationId: GetFirmwareSasExpanderDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.SasExpanderDescriptor' resource. operationId: DeleteFirmwareSasExpanderDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.SasExpanderDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/ServerConfigurationUtilityDistributables: post: tags: - firmware summary: Create a 'firmware.ServerConfigurationUtilityDistributable' resource. operationId: CreateFirmwareServerConfigurationUtilityDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.ServerConfigurationUtilityDistributable - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.ServerConfigurationUtilityDistributable' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ServerConfigurationUtilityDistributable' resource was created as requested. The 'firmware.ServerConfigurationUtilityDistributable' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' links: GetFirmwareServerConfigurationUtilityDistributableByMoid: operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.ServerConfigurationUtilityDistributable' 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/firmware.ServerConfigurationUtilityDistributable' links: GetFirmwareServerConfigurationUtilityDistributableByMoid: operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - firmware summary: Read a 'firmware.ServerConfigurationUtilityDistributable' resource. operationId: GetFirmwareServerConfigurationUtilityDistributableList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.ServerConfigurationUtilityDistributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.ServerConfigurationUtilityDistributable' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}: post: tags: - firmware summary: Update a 'firmware.ServerConfigurationUtilityDistributable' resource. operationId: UpdateFirmwareServerConfigurationUtilityDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.ServerConfigurationUtilityDistributable parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.ServerConfigurationUtilityDistributable' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ServerConfigurationUtilityDistributable' resource was modified as requested. The 'firmware.ServerConfigurationUtilityDistributable' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' links: GetFirmwareServerConfigurationUtilityDistributableByMoid: operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.ServerConfigurationUtilityDistributable' resource is asynchronously being modified 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/firmware.ServerConfigurationUtilityDistributable' links: GetFirmwareServerConfigurationUtilityDistributableByMoid: operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.ServerConfigurationUtilityDistributable' resource. operationId: PatchFirmwareServerConfigurationUtilityDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.firmware.ServerConfigurationUtilityDistributable parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.ServerConfigurationUtilityDistributable' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ServerConfigurationUtilityDistributable' resource was patched as requested. The 'firmware.ServerConfigurationUtilityDistributable' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' links: GetFirmwareServerConfigurationUtilityDistributableByMoid: operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.ServerConfigurationUtilityDistributable' resource is asynchronously being patched 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/firmware.ServerConfigurationUtilityDistributable' links: GetFirmwareServerConfigurationUtilityDistributableByMoid: operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - firmware summary: Read a 'firmware.ServerConfigurationUtilityDistributable' resource. operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.firmware.ServerConfigurationUtilityDistributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.ServerConfigurationUtilityDistributable' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareServerConfigurationUtilityDistributableByMoid: operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.ServerConfigurationUtilityDistributable' resource. operationId: DeleteFirmwareServerConfigurationUtilityDistributable security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.ServerConfigurationUtilityDistributable - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/StorageControllerDescriptors: get: tags: - firmware summary: Read a 'firmware.StorageControllerDescriptor' resource. operationId: GetFirmwareStorageControllerDescriptorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.StorageControllerDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'firmware.StorageControllerDescriptor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.StorageControllerDescriptor' resource. operationId: CreateFirmwareStorageControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.StorageControllerDescriptor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.StorageControllerDescriptor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.StorageControllerDescriptor' resource was created as requested. The 'firmware.StorageControllerDescriptor' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' links: GetFirmwareStorageControllerDescriptorByMoid: operationId: GetFirmwareStorageControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.StorageControllerDescriptor' 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/firmware.StorageControllerDescriptor' links: GetFirmwareStorageControllerDescriptorByMoid: operationId: GetFirmwareStorageControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/StorageControllerDescriptors/{Moid}: get: tags: - firmware summary: Read a 'firmware.StorageControllerDescriptor' resource. operationId: GetFirmwareStorageControllerDescriptorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Read-Only - READ.firmware.StorageControllerDescriptor - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.StorageControllerDescriptor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareStorageControllerDescriptorByMoid: operationId: GetFirmwareStorageControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Update a 'firmware.StorageControllerDescriptor' resource. operationId: UpdateFirmwareStorageControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.StorageControllerDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.StorageControllerDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.StorageControllerDescriptor' resource was modified as requested. The 'firmware.StorageControllerDescriptor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' links: GetFirmwareStorageControllerDescriptorByMoid: operationId: GetFirmwareStorageControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.StorageControllerDescriptor' resource is asynchronously being modified 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/firmware.StorageControllerDescriptor' links: GetFirmwareStorageControllerDescriptorByMoid: operationId: GetFirmwareStorageControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - firmware summary: Update a 'firmware.StorageControllerDescriptor' resource. operationId: PatchFirmwareStorageControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.firmware.StorageControllerDescriptor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'firmware.StorageControllerDescriptor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.StorageControllerDescriptor' resource was patched as requested. The 'firmware.StorageControllerDescriptor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' links: GetFirmwareStorageControllerDescriptorByMoid: operationId: GetFirmwareStorageControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.StorageControllerDescriptor' resource is asynchronously being patched 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/firmware.StorageControllerDescriptor' links: GetFirmwareStorageControllerDescriptorByMoid: operationId: GetFirmwareStorageControllerDescriptorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.StorageControllerDescriptor' resource. operationId: DeleteFirmwareStorageControllerDescriptor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.StorageControllerDescriptor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/SwitchUpgrades: get: tags: - firmware summary: Read a 'firmware.SwitchUpgrade' resource. operationId: GetFirmwareSwitchUpgradeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.firmware.SwitchUpgrade - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'firmware.SwitchUpgrade' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.SwitchUpgrade.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.SwitchUpgrade' resource. operationId: CreateFirmwareSwitchUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.SwitchUpgrade - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.SwitchUpgrade' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.SwitchUpgrade' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.SwitchUpgrade' resource was created as requested. The 'firmware.SwitchUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.SwitchUpgrade' links: GetFirmwareSwitchUpgradeByMoid: operationId: GetFirmwareSwitchUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SwitchUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.SwitchUpgrade' 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/firmware.SwitchUpgrade' links: GetFirmwareSwitchUpgradeByMoid: operationId: GetFirmwareSwitchUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SwitchUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/SwitchUpgrades/{Moid}: get: tags: - firmware summary: Read a 'firmware.SwitchUpgrade' resource. operationId: GetFirmwareSwitchUpgradeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.firmware.SwitchUpgrade - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.SwitchUpgrade' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.SwitchUpgrade' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareSwitchUpgradeByMoid: operationId: GetFirmwareSwitchUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SwitchUpgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.SwitchUpgrade' resource. operationId: DeleteFirmwareSwitchUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.SwitchUpgrade - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/Upgrades: get: tags: - firmware summary: Read a 'firmware.Upgrade' resource. operationId: GetFirmwareUpgradeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.firmware.Upgrade - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'firmware.Upgrade' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.Upgrade.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - firmware summary: Create a 'firmware.Upgrade' resource. operationId: CreateFirmwareUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.Upgrade - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.Upgrade' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.Upgrade' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Upgrade' resource was created as requested. The 'firmware.Upgrade' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.Upgrade' links: GetFirmwareUpgradeByMoid: operationId: GetFirmwareUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.Upgrade' 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/firmware.Upgrade' links: GetFirmwareUpgradeByMoid: operationId: GetFirmwareUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/Upgrades/{Moid}: get: tags: - firmware summary: Read a 'firmware.Upgrade' resource. operationId: GetFirmwareUpgradeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.firmware.Upgrade - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.Upgrade' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.Upgrade' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareUpgradeByMoid: operationId: GetFirmwareUpgradeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - firmware summary: Delete a 'firmware.Upgrade' resource. operationId: DeleteFirmwareUpgrade security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.firmware.Upgrade - PRIVSET.Account Administrator - PRIVSET.Manage Servers - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/UpgradeImpacts: post: tags: - firmware summary: Create a 'firmware.UpgradeImpact' resource. operationId: CreateFirmwareUpgradeImpact security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.firmware.UpgradeImpact - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'firmware.UpgradeImpact' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/firmware.UpgradeImpact' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.UpgradeImpact' resource was created as requested. The 'firmware.UpgradeImpact' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/firmware.UpgradeImpact' links: GetFirmwareUpgradeImpactByMoid: operationId: GetFirmwareUpgradeImpactByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeImpacts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'firmware.UpgradeImpact' 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/firmware.UpgradeImpact' links: GetFirmwareUpgradeImpactByMoid: operationId: GetFirmwareUpgradeImpactByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeImpacts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/UpgradeImpactStatuses: get: tags: - firmware summary: Read a 'firmware.UpgradeImpactStatus' resource. operationId: GetFirmwareUpgradeImpactStatusList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.firmware.UpgradeImpactStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'firmware.UpgradeImpactStatus' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.UpgradeImpactStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/UpgradeImpactStatuses/{Moid}: get: tags: - firmware summary: Read a 'firmware.UpgradeImpactStatus' resource. operationId: GetFirmwareUpgradeImpactStatusByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.firmware.UpgradeImpactStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.UpgradeImpactStatus' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.UpgradeImpactStatus' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareUpgradeImpactStatusByMoid: operationId: GetFirmwareUpgradeImpactStatusByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeImpactStatuses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/UpgradeStatuses: get: tags: - firmware summary: Read a 'firmware.UpgradeStatus' resource. operationId: GetFirmwareUpgradeStatusList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.firmware.UpgradeStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'firmware.UpgradeStatus' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/firmware.UpgradeStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/firmware/UpgradeStatuses/{Moid}: get: tags: - firmware summary: Read a 'firmware.UpgradeStatus' resource. operationId: GetFirmwareUpgradeStatusByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.firmware.UpgradeStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'firmware.UpgradeStatus' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/firmware.UpgradeStatus' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetFirmwareUpgradeStatusByMoid: operationId: GetFirmwareUpgradeStatusByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeStatuses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/forecast/Catalogs: get: tags: - forecast summary: Read a 'forecast.Catalog' resource. operationId: GetForecastCatalogList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.forecast.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 'forecast.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: # Response as JSON document. schema: $ref: '#/components/schemas/forecast.Catalog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/forecast/Catalogs/{Moid}: get: tags: - forecast summary: Read a 'forecast.Catalog' resource. operationId: GetForecastCatalogByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.forecast.Catalog - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'forecast.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/forecast.Catalog' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetForecastCatalogByMoid: operationId: GetForecastCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/forecast/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/forecast/Definitions: get: tags: - forecast summary: Read a 'forecast.Definition' resource. operationId: GetForecastDefinitionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.forecast.Definition - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'forecast.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: # Response as JSON document. schema: $ref: '#/components/schemas/forecast.Definition.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/forecast/Definitions/{Moid}: get: tags: - forecast summary: Read a 'forecast.Definition' resource. operationId: GetForecastDefinitionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.forecast.Definition - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'forecast.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/forecast.Definition' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetForecastDefinitionByMoid: operationId: GetForecastDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/forecast/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/forecast/Instances: get: tags: - forecast summary: Read a 'forecast.Instance' resource. operationId: GetForecastInstanceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.forecast.Instance - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'forecast.Instance' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/forecast.Instance.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/forecast/Instances/{Moid}: get: tags: - forecast summary: Read a 'forecast.Instance' resource. operationId: GetForecastInstanceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.forecast.Instance - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'forecast.Instance' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/forecast.Instance' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetForecastInstanceByMoid: operationId: GetForecastInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/forecast/Instances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/graphics/Cards: get: tags: - graphics summary: Read a 'graphics.Card' resource. operationId: GetGraphicsCardList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.graphics.Card - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'graphics.Card' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/graphics.Card.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/graphics/Cards/{Moid}: get: tags: - graphics summary: Read a 'graphics.Card' resource. operationId: GetGraphicsCardByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.graphics.Card - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'graphics.Card' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/graphics.Card' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetGraphicsCardByMoid: operationId: GetGraphicsCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - graphics summary: Update a 'graphics.Card' resource. operationId: UpdateGraphicsCard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.graphics.Card parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'graphics.Card' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/graphics.Card' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Card' resource was modified as requested. The 'graphics.Card' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/graphics.Card' links: GetGraphicsCardByMoid: operationId: GetGraphicsCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'graphics.Card' resource is asynchronously being modified 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/graphics.Card' links: GetGraphicsCardByMoid: operationId: GetGraphicsCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - graphics summary: Update a 'graphics.Card' resource. operationId: PatchGraphicsCard security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.graphics.Card parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'graphics.Card' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/graphics.Card' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Card' resource was patched as requested. The 'graphics.Card' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/graphics.Card' links: GetGraphicsCardByMoid: operationId: GetGraphicsCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'graphics.Card' resource is asynchronously being patched 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/graphics.Card' links: GetGraphicsCardByMoid: operationId: GetGraphicsCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/graphics/Controllers: get: tags: - graphics summary: Read a 'graphics.Controller' resource. operationId: GetGraphicsControllerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.graphics.Controller - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'graphics.Controller' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/graphics.Controller.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/graphics/Controllers/{Moid}: get: tags: - graphics summary: Read a 'graphics.Controller' resource. operationId: GetGraphicsControllerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.graphics.Controller - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'graphics.Controller' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/graphics.Controller' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetGraphicsControllerByMoid: operationId: GetGraphicsControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - graphics summary: Update a 'graphics.Controller' resource. operationId: UpdateGraphicsController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.graphics.Controller parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'graphics.Controller' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/graphics.Controller' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Controller' resource was modified as requested. The 'graphics.Controller' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/graphics.Controller' links: GetGraphicsControllerByMoid: operationId: GetGraphicsControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'graphics.Controller' resource is asynchronously being modified 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/graphics.Controller' links: GetGraphicsControllerByMoid: operationId: GetGraphicsControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - graphics summary: Update a 'graphics.Controller' resource. operationId: PatchGraphicsController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.graphics.Controller parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'graphics.Controller' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/graphics.Controller' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Controller' resource was patched as requested. The 'graphics.Controller' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/graphics.Controller' links: GetGraphicsControllerByMoid: operationId: GetGraphicsControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'graphics.Controller' resource is asynchronously being patched 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/graphics.Controller' links: GetGraphicsControllerByMoid: operationId: GetGraphicsControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/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.View Servers - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'hcl.CompatibilityStatus' 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/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/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.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/hcl.DriverImage.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # Response as JSON document. schema: $ref: '#/components/schemas/hcl.ExemptedCatalog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/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.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: # Response as JSON document. schema: $ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hcl summary: Create a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. operationId: CreateHclHyperflexSoftwareCompatibilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hcl.HyperflexSoftwareCompatibilityInfo parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hcl.HyperflexSoftwareCompatibilityInfo' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hcl.HyperflexSoftwareCompatibilityInfo' resource was created as requested. The 'hcl.HyperflexSoftwareCompatibilityInfo' 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.HyperflexSoftwareCompatibilityInfo' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'hcl.HyperflexSoftwareCompatibilityInfo' 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/hcl.HyperflexSoftwareCompatibilityInfo' 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/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.View HyperFlex Cluster Profiles - READ.hcl.HyperflexSoftwareCompatibilityInfo - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' post: tags: - hcl summary: Update a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. operationId: UpdateHclHyperflexSoftwareCompatibilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hcl.HyperflexSoftwareCompatibilityInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hcl.HyperflexSoftwareCompatibilityInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hcl.HyperflexSoftwareCompatibilityInfo' resource was modified as requested. The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. 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.HyperflexSoftwareCompatibilityInfo' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is asynchronously being modified 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/hcl.HyperflexSoftwareCompatibilityInfo' 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' patch: tags: - hcl summary: Update a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. operationId: PatchHclHyperflexSoftwareCompatibilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hcl.HyperflexSoftwareCompatibilityInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hcl.HyperflexSoftwareCompatibilityInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hcl.HyperflexSoftwareCompatibilityInfo' resource was patched as requested. The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. 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.HyperflexSoftwareCompatibilityInfo' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is asynchronously being patched 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/hcl.HyperflexSoftwareCompatibilityInfo' 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' delete: tags: - hcl summary: Delete a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. operationId: DeleteHclHyperflexSoftwareCompatibilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hcl.HyperflexSoftwareCompatibilityInfo 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hcl/OperatingSystems: get: tags: - hcl summary: Read a 'hcl.OperatingSystem' resource. operationId: GetHclOperatingSystemList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.hcl.OperatingSystem - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/hcl.OperatingSystem.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.hcl.OperatingSystem - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.hcl.OperatingSystemVendor - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/hcl.OperatingSystemVendor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.hcl.OperatingSystemVendor - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/ServiceStatuses: get: tags: - hcl summary: Read a 'hcl.ServiceStatus' resource. operationId: GetHclServiceStatusList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.hcl.ServiceStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'hcl.ServiceStatus' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hcl.ServiceStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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/ServiceStatuses/{Moid}: get: tags: - hcl summary: Read a 'hcl.ServiceStatus' resource. operationId: GetHclServiceStatusByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.hcl.ServiceStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hcl.ServiceStatus' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/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.ServiceStatus' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHclServiceStatusByMoid: operationId: GetHclServiceStatusByMoid 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/ServiceStatuses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'hcl.SupportedDriverName' 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/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/hyperflex/Alarms: get: tags: - hyperflex summary: Read a 'hyperflex.Alarm' resource. operationId: GetHyperflexAlarmList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.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 'hyperflex.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: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.Alarm.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/Alarms/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.Alarm' resource. operationId: GetHyperflexAlarmByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.Alarm - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.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/hyperflex.Alarm' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexAlarmByMoid: operationId: GetHyperflexAlarmByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/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/hyperflex/AppCatalogs: get: tags: - hyperflex summary: Read a 'hyperflex.AppCatalog' resource. operationId: GetHyperflexAppCatalogList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.AppCatalog - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.AppCatalog' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.AppCatalog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.AppCatalog' resource. operationId: CreateHyperflexAppCatalog security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.AppCatalog parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.AppCatalog' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.AppCatalog' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.AppCatalog' resource was created as requested. The 'hyperflex.AppCatalog' 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/hyperflex.AppCatalog' links: GetHyperflexAppCatalogByMoid: operationId: GetHyperflexAppCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{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 'hyperflex.AppCatalog' 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/hyperflex.AppCatalog' links: GetHyperflexAppCatalogByMoid: operationId: GetHyperflexAppCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/AppCatalogs/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.AppCatalog' resource. operationId: GetHyperflexAppCatalogByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.AppCatalog - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.AppCatalog' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.AppCatalog' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexAppCatalogByMoid: operationId: GetHyperflexAppCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.AppCatalog' resource. operationId: UpdateHyperflexAppCatalog security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.AppCatalog parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.AppCatalog' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.AppCatalog' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.AppCatalog' resource was modified as requested. The 'hyperflex.AppCatalog' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.AppCatalog' links: GetHyperflexAppCatalogByMoid: operationId: GetHyperflexAppCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{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 'hyperflex.AppCatalog' resource is asynchronously being modified 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/hyperflex.AppCatalog' links: GetHyperflexAppCatalogByMoid: operationId: GetHyperflexAppCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.AppCatalog' resource. operationId: PatchHyperflexAppCatalog security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.AppCatalog parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.AppCatalog' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.AppCatalog' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.AppCatalog' resource was patched as requested. The 'hyperflex.AppCatalog' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.AppCatalog' links: GetHyperflexAppCatalogByMoid: operationId: GetHyperflexAppCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{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 'hyperflex.AppCatalog' resource is asynchronously being patched 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/hyperflex.AppCatalog' links: GetHyperflexAppCatalogByMoid: operationId: GetHyperflexAppCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.AppCatalog' resource. operationId: DeleteHyperflexAppCatalog security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.AppCatalog 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/AutoSupportPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.AutoSupportPolicy' resource. operationId: GetHyperflexAutoSupportPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.AutoSupportPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.AutoSupportPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.AutoSupportPolicy' resource. operationId: CreateHyperflexAutoSupportPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.AutoSupportPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.AutoSupportPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.AutoSupportPolicy' resource was created as requested. The 'hyperflex.AutoSupportPolicy' 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/hyperflex.AutoSupportPolicy' links: GetHyperflexAutoSupportPolicyByMoid: operationId: GetHyperflexAutoSupportPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{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 'hyperflex.AutoSupportPolicy' 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/hyperflex.AutoSupportPolicy' links: GetHyperflexAutoSupportPolicyByMoid: operationId: GetHyperflexAutoSupportPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/AutoSupportPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.AutoSupportPolicy' resource. operationId: GetHyperflexAutoSupportPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.AutoSupportPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.AutoSupportPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexAutoSupportPolicyByMoid: operationId: GetHyperflexAutoSupportPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.AutoSupportPolicy' resource. operationId: UpdateHyperflexAutoSupportPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.AutoSupportPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.AutoSupportPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.AutoSupportPolicy' resource was modified as requested. The 'hyperflex.AutoSupportPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' links: GetHyperflexAutoSupportPolicyByMoid: operationId: GetHyperflexAutoSupportPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{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 'hyperflex.AutoSupportPolicy' resource is asynchronously being modified 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/hyperflex.AutoSupportPolicy' links: GetHyperflexAutoSupportPolicyByMoid: operationId: GetHyperflexAutoSupportPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.AutoSupportPolicy' resource. operationId: PatchHyperflexAutoSupportPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.AutoSupportPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.AutoSupportPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.AutoSupportPolicy' resource was patched as requested. The 'hyperflex.AutoSupportPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' links: GetHyperflexAutoSupportPolicyByMoid: operationId: GetHyperflexAutoSupportPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{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 'hyperflex.AutoSupportPolicy' resource is asynchronously being patched 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/hyperflex.AutoSupportPolicy' links: GetHyperflexAutoSupportPolicyByMoid: operationId: GetHyperflexAutoSupportPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.AutoSupportPolicy' resource. operationId: DeleteHyperflexAutoSupportPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.AutoSupportPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/CapabilityInfos: get: tags: - hyperflex summary: Read a 'hyperflex.CapabilityInfo' resource. operationId: GetHyperflexCapabilityInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.CapabilityInfo - 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 'hyperflex.CapabilityInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.CapabilityInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.CapabilityInfo' resource. operationId: CreateHyperflexCapabilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.CapabilityInfo - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.CapabilityInfo' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.CapabilityInfo' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.CapabilityInfo' resource was created as requested. The 'hyperflex.CapabilityInfo' 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/hyperflex.CapabilityInfo' links: GetHyperflexCapabilityInfoByMoid: operationId: GetHyperflexCapabilityInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{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 'hyperflex.CapabilityInfo' 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/hyperflex.CapabilityInfo' links: GetHyperflexCapabilityInfoByMoid: operationId: GetHyperflexCapabilityInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/CapabilityInfos/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.CapabilityInfo' resource. operationId: GetHyperflexCapabilityInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.CapabilityInfo - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.CapabilityInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.CapabilityInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexCapabilityInfoByMoid: operationId: GetHyperflexCapabilityInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.CapabilityInfo' resource. operationId: UpdateHyperflexCapabilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.CapabilityInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.CapabilityInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.CapabilityInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.CapabilityInfo' resource was modified as requested. The 'hyperflex.CapabilityInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.CapabilityInfo' links: GetHyperflexCapabilityInfoByMoid: operationId: GetHyperflexCapabilityInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{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 'hyperflex.CapabilityInfo' resource is asynchronously being modified 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/hyperflex.CapabilityInfo' links: GetHyperflexCapabilityInfoByMoid: operationId: GetHyperflexCapabilityInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.CapabilityInfo' resource. operationId: PatchHyperflexCapabilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.CapabilityInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.CapabilityInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.CapabilityInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.CapabilityInfo' resource was patched as requested. The 'hyperflex.CapabilityInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.CapabilityInfo' links: GetHyperflexCapabilityInfoByMoid: operationId: GetHyperflexCapabilityInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{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 'hyperflex.CapabilityInfo' resource is asynchronously being patched 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/hyperflex.CapabilityInfo' links: GetHyperflexCapabilityInfoByMoid: operationId: GetHyperflexCapabilityInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.CapabilityInfo' resource. operationId: DeleteHyperflexCapabilityInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.CapabilityInfo 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/Clusters: get: tags: - hyperflex summary: Read a 'hyperflex.Cluster' resource. operationId: GetHyperflexClusterList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.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 'hyperflex.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: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.Cluster.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/Clusters/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.Cluster' resource. operationId: GetHyperflexClusterByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.Cluster - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.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/hyperflex.Cluster' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexClusterByMoid: operationId: GetHyperflexClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/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: - hyperflex summary: Update a 'hyperflex.Cluster' resource. operationId: UpdateHyperflexCluster security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - ROLE.Account Administrator - UPDATE.hyperflex.Cluster parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.Cluster' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.Cluster' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.Cluster' resource was modified as requested. The 'hyperflex.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/hyperflex.Cluster' links: GetHyperflexClusterByMoid: operationId: GetHyperflexClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/Clusters/{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 'hyperflex.Cluster' resource is asynchronously being modified 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/hyperflex.Cluster' links: GetHyperflexClusterByMoid: operationId: GetHyperflexClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/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: - hyperflex summary: Update a 'hyperflex.Cluster' resource. operationId: PatchHyperflexCluster security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - ROLE.Account Administrator - UPDATE.hyperflex.Cluster parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.Cluster' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.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 'hyperflex.Cluster' resource was patched as requested. The 'hyperflex.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/hyperflex.Cluster' links: GetHyperflexClusterByMoid: operationId: GetHyperflexClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/Clusters/{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 'hyperflex.Cluster' resource is asynchronously being patched 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/hyperflex.Cluster' links: GetHyperflexClusterByMoid: operationId: GetHyperflexClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/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/hyperflex/ClusterNetworkPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.ClusterNetworkPolicy' resource. operationId: GetHyperflexClusterNetworkPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ClusterNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.ClusterNetworkPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ClusterNetworkPolicy' resource. operationId: CreateHyperflexClusterNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ClusterNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ClusterNetworkPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterNetworkPolicy' resource was created as requested. The 'hyperflex.ClusterNetworkPolicy' 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/hyperflex.ClusterNetworkPolicy' links: GetHyperflexClusterNetworkPolicyByMoid: operationId: GetHyperflexClusterNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{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 'hyperflex.ClusterNetworkPolicy' 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/hyperflex.ClusterNetworkPolicy' links: GetHyperflexClusterNetworkPolicyByMoid: operationId: GetHyperflexClusterNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ClusterNetworkPolicy' resource. operationId: GetHyperflexClusterNetworkPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ClusterNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ClusterNetworkPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexClusterNetworkPolicyByMoid: operationId: GetHyperflexClusterNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ClusterNetworkPolicy' resource. operationId: UpdateHyperflexClusterNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ClusterNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ClusterNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterNetworkPolicy' resource was modified as requested. The 'hyperflex.ClusterNetworkPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' links: GetHyperflexClusterNetworkPolicyByMoid: operationId: GetHyperflexClusterNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{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 'hyperflex.ClusterNetworkPolicy' resource is asynchronously being modified 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/hyperflex.ClusterNetworkPolicy' links: GetHyperflexClusterNetworkPolicyByMoid: operationId: GetHyperflexClusterNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ClusterNetworkPolicy' resource. operationId: PatchHyperflexClusterNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ClusterNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ClusterNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterNetworkPolicy' resource was patched as requested. The 'hyperflex.ClusterNetworkPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' links: GetHyperflexClusterNetworkPolicyByMoid: operationId: GetHyperflexClusterNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{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 'hyperflex.ClusterNetworkPolicy' resource is asynchronously being patched 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/hyperflex.ClusterNetworkPolicy' links: GetHyperflexClusterNetworkPolicyByMoid: operationId: GetHyperflexClusterNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ClusterNetworkPolicy' resource. operationId: DeleteHyperflexClusterNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ClusterNetworkPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/ClusterProfiles: get: tags: - hyperflex summary: Read a 'hyperflex.ClusterProfile' resource. operationId: GetHyperflexClusterProfileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ClusterProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.ClusterProfile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ClusterProfile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ClusterProfile' resource. operationId: CreateHyperflexClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ClusterProfile - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ClusterProfile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterProfile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterProfile' resource was created as requested. The 'hyperflex.ClusterProfile' 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/hyperflex.ClusterProfile' links: GetHyperflexClusterProfileByMoid: operationId: GetHyperflexClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterProfiles/{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 'hyperflex.ClusterProfile' 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/hyperflex.ClusterProfile' links: GetHyperflexClusterProfileByMoid: operationId: GetHyperflexClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ClusterProfiles/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ClusterProfile' resource. operationId: GetHyperflexClusterProfileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ClusterProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ClusterProfile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterProfile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexClusterProfileByMoid: operationId: GetHyperflexClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ClusterProfile' resource. operationId: UpdateHyperflexClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ClusterProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ClusterProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterProfile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterProfile' resource was modified as requested. The 'hyperflex.ClusterProfile' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterProfile' links: GetHyperflexClusterProfileByMoid: operationId: GetHyperflexClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterProfiles/{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 'hyperflex.ClusterProfile' resource is asynchronously being modified 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/hyperflex.ClusterProfile' links: GetHyperflexClusterProfileByMoid: operationId: GetHyperflexClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ClusterProfile' resource. operationId: PatchHyperflexClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ClusterProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ClusterProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterProfile' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterProfile' resource was patched as requested. The 'hyperflex.ClusterProfile' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterProfile' links: GetHyperflexClusterProfileByMoid: operationId: GetHyperflexClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterProfiles/{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 'hyperflex.ClusterProfile' resource is asynchronously being patched 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/hyperflex.ClusterProfile' links: GetHyperflexClusterProfileByMoid: operationId: GetHyperflexClusterProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ClusterProfile' resource. operationId: DeleteHyperflexClusterProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ClusterProfile - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/ClusterStoragePolicies: get: tags: - hyperflex summary: Read a 'hyperflex.ClusterStoragePolicy' resource. operationId: GetHyperflexClusterStoragePolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ClusterStoragePolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.ClusterStoragePolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ClusterStoragePolicy' resource. operationId: CreateHyperflexClusterStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ClusterStoragePolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ClusterStoragePolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterStoragePolicy' resource was created as requested. The 'hyperflex.ClusterStoragePolicy' 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/hyperflex.ClusterStoragePolicy' links: GetHyperflexClusterStoragePolicyByMoid: operationId: GetHyperflexClusterStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterStoragePolicies/{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 'hyperflex.ClusterStoragePolicy' 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/hyperflex.ClusterStoragePolicy' links: GetHyperflexClusterStoragePolicyByMoid: operationId: GetHyperflexClusterStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ClusterStoragePolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ClusterStoragePolicy' resource. operationId: GetHyperflexClusterStoragePolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ClusterStoragePolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ClusterStoragePolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexClusterStoragePolicyByMoid: operationId: GetHyperflexClusterStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ClusterStoragePolicy' resource. operationId: UpdateHyperflexClusterStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ClusterStoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ClusterStoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterStoragePolicy' resource was modified as requested. The 'hyperflex.ClusterStoragePolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' links: GetHyperflexClusterStoragePolicyByMoid: operationId: GetHyperflexClusterStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterStoragePolicies/{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 'hyperflex.ClusterStoragePolicy' resource is asynchronously being modified 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/hyperflex.ClusterStoragePolicy' links: GetHyperflexClusterStoragePolicyByMoid: operationId: GetHyperflexClusterStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ClusterStoragePolicy' resource. operationId: PatchHyperflexClusterStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ClusterStoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ClusterStoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ClusterStoragePolicy' resource was patched as requested. The 'hyperflex.ClusterStoragePolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' links: GetHyperflexClusterStoragePolicyByMoid: operationId: GetHyperflexClusterStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterStoragePolicies/{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 'hyperflex.ClusterStoragePolicy' resource is asynchronously being patched 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/hyperflex.ClusterStoragePolicy' links: GetHyperflexClusterStoragePolicyByMoid: operationId: GetHyperflexClusterStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ClusterStoragePolicy' resource. operationId: DeleteHyperflexClusterStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ClusterStoragePolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/ConfigResults: get: tags: - hyperflex summary: Read a 'hyperflex.ConfigResult' resource. operationId: GetHyperflexConfigResultList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ConfigResult - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.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: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ConfigResult.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ConfigResults/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ConfigResult' resource. operationId: GetHyperflexConfigResultByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ConfigResult - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.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/hyperflex.ConfigResult' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexConfigResultByMoid: operationId: GetHyperflexConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/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/hyperflex/ConfigResultEntries: get: tags: - hyperflex summary: Read a 'hyperflex.ConfigResultEntry' resource. operationId: GetHyperflexConfigResultEntryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ConfigResultEntry - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.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: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ConfigResultEntry.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ConfigResultEntries/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ConfigResultEntry' resource. operationId: GetHyperflexConfigResultEntryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ConfigResultEntry - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.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/hyperflex.ConfigResultEntry' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexConfigResultEntryByMoid: operationId: GetHyperflexConfigResultEntryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/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/hyperflex/ExtFcStoragePolicies: get: tags: - hyperflex summary: Read a 'hyperflex.ExtFcStoragePolicy' resource. operationId: GetHyperflexExtFcStoragePolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ExtFcStoragePolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.ExtFcStoragePolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ExtFcStoragePolicy' resource. operationId: CreateHyperflexExtFcStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ExtFcStoragePolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ExtFcStoragePolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ExtFcStoragePolicy' resource was created as requested. The 'hyperflex.ExtFcStoragePolicy' 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/hyperflex.ExtFcStoragePolicy' links: GetHyperflexExtFcStoragePolicyByMoid: operationId: GetHyperflexExtFcStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtFcStoragePolicies/{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 'hyperflex.ExtFcStoragePolicy' 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/hyperflex.ExtFcStoragePolicy' links: GetHyperflexExtFcStoragePolicyByMoid: operationId: GetHyperflexExtFcStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtFcStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ExtFcStoragePolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ExtFcStoragePolicy' resource. operationId: GetHyperflexExtFcStoragePolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ExtFcStoragePolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ExtFcStoragePolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexExtFcStoragePolicyByMoid: operationId: GetHyperflexExtFcStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtFcStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ExtFcStoragePolicy' resource. operationId: UpdateHyperflexExtFcStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ExtFcStoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ExtFcStoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ExtFcStoragePolicy' resource was modified as requested. The 'hyperflex.ExtFcStoragePolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' links: GetHyperflexExtFcStoragePolicyByMoid: operationId: GetHyperflexExtFcStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtFcStoragePolicies/{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 'hyperflex.ExtFcStoragePolicy' resource is asynchronously being modified 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/hyperflex.ExtFcStoragePolicy' links: GetHyperflexExtFcStoragePolicyByMoid: operationId: GetHyperflexExtFcStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtFcStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ExtFcStoragePolicy' resource. operationId: PatchHyperflexExtFcStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ExtFcStoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ExtFcStoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ExtFcStoragePolicy' resource was patched as requested. The 'hyperflex.ExtFcStoragePolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' links: GetHyperflexExtFcStoragePolicyByMoid: operationId: GetHyperflexExtFcStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtFcStoragePolicies/{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 'hyperflex.ExtFcStoragePolicy' resource is asynchronously being patched 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/hyperflex.ExtFcStoragePolicy' links: GetHyperflexExtFcStoragePolicyByMoid: operationId: GetHyperflexExtFcStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtFcStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ExtFcStoragePolicy' resource. operationId: DeleteHyperflexExtFcStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ExtFcStoragePolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/ExtIscsiStoragePolicies: get: tags: - hyperflex summary: Read a 'hyperflex.ExtIscsiStoragePolicy' resource. operationId: GetHyperflexExtIscsiStoragePolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ExtIscsiStoragePolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.ExtIscsiStoragePolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ExtIscsiStoragePolicy' resource. operationId: CreateHyperflexExtIscsiStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ExtIscsiStoragePolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ExtIscsiStoragePolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ExtIscsiStoragePolicy' resource was created as requested. The 'hyperflex.ExtIscsiStoragePolicy' 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/hyperflex.ExtIscsiStoragePolicy' links: GetHyperflexExtIscsiStoragePolicyByMoid: operationId: GetHyperflexExtIscsiStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtIscsiStoragePolicies/{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 'hyperflex.ExtIscsiStoragePolicy' 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/hyperflex.ExtIscsiStoragePolicy' links: GetHyperflexExtIscsiStoragePolicyByMoid: operationId: GetHyperflexExtIscsiStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtIscsiStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ExtIscsiStoragePolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ExtIscsiStoragePolicy' resource. operationId: GetHyperflexExtIscsiStoragePolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ExtIscsiStoragePolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ExtIscsiStoragePolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexExtIscsiStoragePolicyByMoid: operationId: GetHyperflexExtIscsiStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtIscsiStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ExtIscsiStoragePolicy' resource. operationId: UpdateHyperflexExtIscsiStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ExtIscsiStoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ExtIscsiStoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ExtIscsiStoragePolicy' resource was modified as requested. The 'hyperflex.ExtIscsiStoragePolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' links: GetHyperflexExtIscsiStoragePolicyByMoid: operationId: GetHyperflexExtIscsiStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtIscsiStoragePolicies/{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 'hyperflex.ExtIscsiStoragePolicy' resource is asynchronously being modified 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/hyperflex.ExtIscsiStoragePolicy' links: GetHyperflexExtIscsiStoragePolicyByMoid: operationId: GetHyperflexExtIscsiStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtIscsiStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ExtIscsiStoragePolicy' resource. operationId: PatchHyperflexExtIscsiStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ExtIscsiStoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ExtIscsiStoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ExtIscsiStoragePolicy' resource was patched as requested. The 'hyperflex.ExtIscsiStoragePolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' links: GetHyperflexExtIscsiStoragePolicyByMoid: operationId: GetHyperflexExtIscsiStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtIscsiStoragePolicies/{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 'hyperflex.ExtIscsiStoragePolicy' resource is asynchronously being patched 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/hyperflex.ExtIscsiStoragePolicy' links: GetHyperflexExtIscsiStoragePolicyByMoid: operationId: GetHyperflexExtIscsiStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ExtIscsiStoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ExtIscsiStoragePolicy' resource. operationId: DeleteHyperflexExtIscsiStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ExtIscsiStoragePolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/FeatureLimitExternals: get: tags: - hyperflex summary: Read a 'hyperflex.FeatureLimitExternal' resource. operationId: GetHyperflexFeatureLimitExternalList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.FeatureLimitExternal - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.FeatureLimitExternal' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.FeatureLimitExternal' resource. operationId: CreateHyperflexFeatureLimitExternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.FeatureLimitExternal parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.FeatureLimitExternal' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.FeatureLimitExternal' resource was created as requested. The 'hyperflex.FeatureLimitExternal' 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/hyperflex.FeatureLimitExternal' links: GetHyperflexFeatureLimitExternalByMoid: operationId: GetHyperflexFeatureLimitExternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitExternals/{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 'hyperflex.FeatureLimitExternal' 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/hyperflex.FeatureLimitExternal' links: GetHyperflexFeatureLimitExternalByMoid: operationId: GetHyperflexFeatureLimitExternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitExternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/FeatureLimitExternals/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.FeatureLimitExternal' resource. operationId: GetHyperflexFeatureLimitExternalByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.FeatureLimitExternal - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.FeatureLimitExternal' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexFeatureLimitExternalByMoid: operationId: GetHyperflexFeatureLimitExternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitExternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.FeatureLimitExternal' resource. operationId: UpdateHyperflexFeatureLimitExternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.FeatureLimitExternal parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.FeatureLimitExternal' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.FeatureLimitExternal' resource was modified as requested. The 'hyperflex.FeatureLimitExternal' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' links: GetHyperflexFeatureLimitExternalByMoid: operationId: GetHyperflexFeatureLimitExternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitExternals/{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 'hyperflex.FeatureLimitExternal' resource is asynchronously being modified 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/hyperflex.FeatureLimitExternal' links: GetHyperflexFeatureLimitExternalByMoid: operationId: GetHyperflexFeatureLimitExternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitExternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.FeatureLimitExternal' resource. operationId: PatchHyperflexFeatureLimitExternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.FeatureLimitExternal parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.FeatureLimitExternal' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.FeatureLimitExternal' resource was patched as requested. The 'hyperflex.FeatureLimitExternal' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' links: GetHyperflexFeatureLimitExternalByMoid: operationId: GetHyperflexFeatureLimitExternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitExternals/{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 'hyperflex.FeatureLimitExternal' resource is asynchronously being patched 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/hyperflex.FeatureLimitExternal' links: GetHyperflexFeatureLimitExternalByMoid: operationId: GetHyperflexFeatureLimitExternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitExternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.FeatureLimitExternal' resource. operationId: DeleteHyperflexFeatureLimitExternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.FeatureLimitExternal 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/FeatureLimitInternals: get: tags: - hyperflex summary: Read a 'hyperflex.FeatureLimitInternal' resource. operationId: GetHyperflexFeatureLimitInternalList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.FeatureLimitInternal - 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 'hyperflex.FeatureLimitInternal' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.FeatureLimitInternal' resource. operationId: CreateHyperflexFeatureLimitInternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.FeatureLimitInternal parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.FeatureLimitInternal' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.FeatureLimitInternal' resource was created as requested. The 'hyperflex.FeatureLimitInternal' 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/hyperflex.FeatureLimitInternal' links: GetHyperflexFeatureLimitInternalByMoid: operationId: GetHyperflexFeatureLimitInternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitInternals/{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 'hyperflex.FeatureLimitInternal' 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/hyperflex.FeatureLimitInternal' links: GetHyperflexFeatureLimitInternalByMoid: operationId: GetHyperflexFeatureLimitInternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitInternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/FeatureLimitInternals/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.FeatureLimitInternal' resource. operationId: GetHyperflexFeatureLimitInternalByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.FeatureLimitInternal - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.FeatureLimitInternal' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexFeatureLimitInternalByMoid: operationId: GetHyperflexFeatureLimitInternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitInternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.FeatureLimitInternal' resource. operationId: UpdateHyperflexFeatureLimitInternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.FeatureLimitInternal parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.FeatureLimitInternal' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.FeatureLimitInternal' resource was modified as requested. The 'hyperflex.FeatureLimitInternal' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' links: GetHyperflexFeatureLimitInternalByMoid: operationId: GetHyperflexFeatureLimitInternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitInternals/{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 'hyperflex.FeatureLimitInternal' resource is asynchronously being modified 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/hyperflex.FeatureLimitInternal' links: GetHyperflexFeatureLimitInternalByMoid: operationId: GetHyperflexFeatureLimitInternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitInternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.FeatureLimitInternal' resource. operationId: PatchHyperflexFeatureLimitInternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.FeatureLimitInternal parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.FeatureLimitInternal' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.FeatureLimitInternal' resource was patched as requested. The 'hyperflex.FeatureLimitInternal' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' links: GetHyperflexFeatureLimitInternalByMoid: operationId: GetHyperflexFeatureLimitInternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitInternals/{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 'hyperflex.FeatureLimitInternal' resource is asynchronously being patched 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/hyperflex.FeatureLimitInternal' links: GetHyperflexFeatureLimitInternalByMoid: operationId: GetHyperflexFeatureLimitInternalByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/FeatureLimitInternals/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.FeatureLimitInternal' resource. operationId: DeleteHyperflexFeatureLimitInternal security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.FeatureLimitInternal 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/Healths: get: tags: - hyperflex summary: Read a 'hyperflex.Health' resource. operationId: GetHyperflexHealthList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.Health - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.Health' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.Health.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/Healths/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.Health' resource. operationId: GetHyperflexHealthByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.Health - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.Health' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.Health' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexHealthByMoid: operationId: GetHyperflexHealthByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/Healths/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/HxdpVersions: get: tags: - hyperflex summary: Read a 'hyperflex.HxdpVersion' resource. operationId: GetHyperflexHxdpVersionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.HxdpVersion - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.HxdpVersion' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.HxdpVersion.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.HxdpVersion' resource. operationId: CreateHyperflexHxdpVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.HxdpVersion parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.HxdpVersion' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.HxdpVersion' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.HxdpVersion' resource was created as requested. The 'hyperflex.HxdpVersion' 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/hyperflex.HxdpVersion' links: GetHyperflexHxdpVersionByMoid: operationId: GetHyperflexHxdpVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/HxdpVersions/{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 'hyperflex.HxdpVersion' 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/hyperflex.HxdpVersion' links: GetHyperflexHxdpVersionByMoid: operationId: GetHyperflexHxdpVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/HxdpVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/HxdpVersions/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.HxdpVersion' resource. operationId: GetHyperflexHxdpVersionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.HxdpVersion - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.HxdpVersion' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.HxdpVersion' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexHxdpVersionByMoid: operationId: GetHyperflexHxdpVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/HxdpVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.HxdpVersion' resource. operationId: UpdateHyperflexHxdpVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.HxdpVersion parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.HxdpVersion' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.HxdpVersion' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.HxdpVersion' resource was modified as requested. The 'hyperflex.HxdpVersion' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.HxdpVersion' links: GetHyperflexHxdpVersionByMoid: operationId: GetHyperflexHxdpVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/HxdpVersions/{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 'hyperflex.HxdpVersion' resource is asynchronously being modified 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/hyperflex.HxdpVersion' links: GetHyperflexHxdpVersionByMoid: operationId: GetHyperflexHxdpVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/HxdpVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.HxdpVersion' resource. operationId: PatchHyperflexHxdpVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.HxdpVersion parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.HxdpVersion' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.HxdpVersion' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.HxdpVersion' resource was patched as requested. The 'hyperflex.HxdpVersion' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.HxdpVersion' links: GetHyperflexHxdpVersionByMoid: operationId: GetHyperflexHxdpVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/HxdpVersions/{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 'hyperflex.HxdpVersion' resource is asynchronously being patched 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/hyperflex.HxdpVersion' links: GetHyperflexHxdpVersionByMoid: operationId: GetHyperflexHxdpVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/HxdpVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.HxdpVersion' resource. operationId: DeleteHyperflexHxdpVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.HxdpVersion 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/LocalCredentialPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.LocalCredentialPolicy' resource. operationId: GetHyperflexLocalCredentialPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.LocalCredentialPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.LocalCredentialPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.LocalCredentialPolicy' resource. operationId: CreateHyperflexLocalCredentialPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.LocalCredentialPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.LocalCredentialPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.LocalCredentialPolicy' resource was created as requested. The 'hyperflex.LocalCredentialPolicy' 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/hyperflex.LocalCredentialPolicy' links: GetHyperflexLocalCredentialPolicyByMoid: operationId: GetHyperflexLocalCredentialPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/LocalCredentialPolicies/{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 'hyperflex.LocalCredentialPolicy' 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/hyperflex.LocalCredentialPolicy' links: GetHyperflexLocalCredentialPolicyByMoid: operationId: GetHyperflexLocalCredentialPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/LocalCredentialPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/LocalCredentialPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.LocalCredentialPolicy' resource. operationId: GetHyperflexLocalCredentialPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.LocalCredentialPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.LocalCredentialPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexLocalCredentialPolicyByMoid: operationId: GetHyperflexLocalCredentialPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/LocalCredentialPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.LocalCredentialPolicy' resource. operationId: UpdateHyperflexLocalCredentialPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.LocalCredentialPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.LocalCredentialPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.LocalCredentialPolicy' resource was modified as requested. The 'hyperflex.LocalCredentialPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' links: GetHyperflexLocalCredentialPolicyByMoid: operationId: GetHyperflexLocalCredentialPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/LocalCredentialPolicies/{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 'hyperflex.LocalCredentialPolicy' resource is asynchronously being modified 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/hyperflex.LocalCredentialPolicy' links: GetHyperflexLocalCredentialPolicyByMoid: operationId: GetHyperflexLocalCredentialPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/LocalCredentialPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.LocalCredentialPolicy' resource. operationId: PatchHyperflexLocalCredentialPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.LocalCredentialPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.LocalCredentialPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.LocalCredentialPolicy' resource was patched as requested. The 'hyperflex.LocalCredentialPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' links: GetHyperflexLocalCredentialPolicyByMoid: operationId: GetHyperflexLocalCredentialPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/LocalCredentialPolicies/{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 'hyperflex.LocalCredentialPolicy' resource is asynchronously being patched 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/hyperflex.LocalCredentialPolicy' links: GetHyperflexLocalCredentialPolicyByMoid: operationId: GetHyperflexLocalCredentialPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/LocalCredentialPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.LocalCredentialPolicy' resource. operationId: DeleteHyperflexLocalCredentialPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.LocalCredentialPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/Nodes: get: tags: - hyperflex summary: Read a 'hyperflex.Node' resource. operationId: GetHyperflexNodeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.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 'hyperflex.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: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.Node.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/Nodes/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.Node' resource. operationId: GetHyperflexNodeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Read-Only - PRIVSET.View HyperFlex Clusters - READ.hyperflex.Node - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.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/hyperflex.Node' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexNodeByMoid: operationId: GetHyperflexNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/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/hyperflex/NodeConfigPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.NodeConfigPolicy' resource. operationId: GetHyperflexNodeConfigPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.NodeConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.NodeConfigPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.NodeConfigPolicy' resource. operationId: CreateHyperflexNodeConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.NodeConfigPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.NodeConfigPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.NodeConfigPolicy' resource was created as requested. The 'hyperflex.NodeConfigPolicy' 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/hyperflex.NodeConfigPolicy' links: GetHyperflexNodeConfigPolicyByMoid: operationId: GetHyperflexNodeConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeConfigPolicies/{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 'hyperflex.NodeConfigPolicy' 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/hyperflex.NodeConfigPolicy' links: GetHyperflexNodeConfigPolicyByMoid: operationId: GetHyperflexNodeConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/NodeConfigPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.NodeConfigPolicy' resource. operationId: GetHyperflexNodeConfigPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.NodeConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.NodeConfigPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexNodeConfigPolicyByMoid: operationId: GetHyperflexNodeConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.NodeConfigPolicy' resource. operationId: UpdateHyperflexNodeConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.NodeConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.NodeConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.NodeConfigPolicy' resource was modified as requested. The 'hyperflex.NodeConfigPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' links: GetHyperflexNodeConfigPolicyByMoid: operationId: GetHyperflexNodeConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeConfigPolicies/{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 'hyperflex.NodeConfigPolicy' resource is asynchronously being modified 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/hyperflex.NodeConfigPolicy' links: GetHyperflexNodeConfigPolicyByMoid: operationId: GetHyperflexNodeConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.NodeConfigPolicy' resource. operationId: PatchHyperflexNodeConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.NodeConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.NodeConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.NodeConfigPolicy' resource was patched as requested. The 'hyperflex.NodeConfigPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' links: GetHyperflexNodeConfigPolicyByMoid: operationId: GetHyperflexNodeConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeConfigPolicies/{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 'hyperflex.NodeConfigPolicy' resource is asynchronously being patched 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/hyperflex.NodeConfigPolicy' links: GetHyperflexNodeConfigPolicyByMoid: operationId: GetHyperflexNodeConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.NodeConfigPolicy' resource. operationId: DeleteHyperflexNodeConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.NodeConfigPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/NodeProfiles: get: tags: - hyperflex summary: Read a 'hyperflex.NodeProfile' resource. operationId: GetHyperflexNodeProfileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.NodeProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.NodeProfile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.NodeProfile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.NodeProfile' resource. operationId: CreateHyperflexNodeProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.NodeProfile - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.NodeProfile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeProfile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.NodeProfile' resource was created as requested. The 'hyperflex.NodeProfile' 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/hyperflex.NodeProfile' links: GetHyperflexNodeProfileByMoid: operationId: GetHyperflexNodeProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeProfiles/{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 'hyperflex.NodeProfile' 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/hyperflex.NodeProfile' links: GetHyperflexNodeProfileByMoid: operationId: GetHyperflexNodeProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/NodeProfiles/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.NodeProfile' resource. operationId: GetHyperflexNodeProfileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.NodeProfile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.NodeProfile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeProfile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexNodeProfileByMoid: operationId: GetHyperflexNodeProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.NodeProfile' resource. operationId: UpdateHyperflexNodeProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.NodeProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.NodeProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.NodeProfile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.NodeProfile' resource was modified as requested. The 'hyperflex.NodeProfile' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeProfile' links: GetHyperflexNodeProfileByMoid: operationId: GetHyperflexNodeProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeProfiles/{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 'hyperflex.NodeProfile' resource is asynchronously being modified 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/hyperflex.NodeProfile' links: GetHyperflexNodeProfileByMoid: operationId: GetHyperflexNodeProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.NodeProfile' resource. operationId: PatchHyperflexNodeProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.NodeProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.NodeProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.NodeProfile' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.NodeProfile' resource was patched as requested. The 'hyperflex.NodeProfile' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.NodeProfile' links: GetHyperflexNodeProfileByMoid: operationId: GetHyperflexNodeProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeProfiles/{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 'hyperflex.NodeProfile' resource is asynchronously being patched 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/hyperflex.NodeProfile' links: GetHyperflexNodeProfileByMoid: operationId: GetHyperflexNodeProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/NodeProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.NodeProfile' resource. operationId: DeleteHyperflexNodeProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.NodeProfile - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/ProxySettingPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.ProxySettingPolicy' resource. operationId: GetHyperflexProxySettingPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ProxySettingPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.ProxySettingPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ProxySettingPolicy' resource. operationId: CreateHyperflexProxySettingPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ProxySettingPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ProxySettingPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ProxySettingPolicy' resource was created as requested. The 'hyperflex.ProxySettingPolicy' 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/hyperflex.ProxySettingPolicy' links: GetHyperflexProxySettingPolicyByMoid: operationId: GetHyperflexProxySettingPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ProxySettingPolicies/{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 'hyperflex.ProxySettingPolicy' 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/hyperflex.ProxySettingPolicy' links: GetHyperflexProxySettingPolicyByMoid: operationId: GetHyperflexProxySettingPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ProxySettingPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ProxySettingPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ProxySettingPolicy' resource. operationId: GetHyperflexProxySettingPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ProxySettingPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ProxySettingPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexProxySettingPolicyByMoid: operationId: GetHyperflexProxySettingPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ProxySettingPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ProxySettingPolicy' resource. operationId: UpdateHyperflexProxySettingPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ProxySettingPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ProxySettingPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ProxySettingPolicy' resource was modified as requested. The 'hyperflex.ProxySettingPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' links: GetHyperflexProxySettingPolicyByMoid: operationId: GetHyperflexProxySettingPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ProxySettingPolicies/{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 'hyperflex.ProxySettingPolicy' resource is asynchronously being modified 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/hyperflex.ProxySettingPolicy' links: GetHyperflexProxySettingPolicyByMoid: operationId: GetHyperflexProxySettingPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ProxySettingPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ProxySettingPolicy' resource. operationId: PatchHyperflexProxySettingPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.ProxySettingPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ProxySettingPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ProxySettingPolicy' resource was patched as requested. The 'hyperflex.ProxySettingPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' links: GetHyperflexProxySettingPolicyByMoid: operationId: GetHyperflexProxySettingPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ProxySettingPolicies/{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 'hyperflex.ProxySettingPolicy' resource is asynchronously being patched 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/hyperflex.ProxySettingPolicy' links: GetHyperflexProxySettingPolicyByMoid: operationId: GetHyperflexProxySettingPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ProxySettingPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ProxySettingPolicy' resource. operationId: DeleteHyperflexProxySettingPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ProxySettingPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/ServerFirmwareVersions: get: tags: - hyperflex summary: Read a 'hyperflex.ServerFirmwareVersion' resource. operationId: GetHyperflexServerFirmwareVersionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ServerFirmwareVersion - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.ServerFirmwareVersion' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ServerFirmwareVersion' resource. operationId: CreateHyperflexServerFirmwareVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ServerFirmwareVersion parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ServerFirmwareVersion' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ServerFirmwareVersion' resource was created as requested. The 'hyperflex.ServerFirmwareVersion' 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/hyperflex.ServerFirmwareVersion' links: GetHyperflexServerFirmwareVersionByMoid: operationId: GetHyperflexServerFirmwareVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerFirmwareVersions/{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 'hyperflex.ServerFirmwareVersion' 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/hyperflex.ServerFirmwareVersion' links: GetHyperflexServerFirmwareVersionByMoid: operationId: GetHyperflexServerFirmwareVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerFirmwareVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ServerFirmwareVersions/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ServerFirmwareVersion' resource. operationId: GetHyperflexServerFirmwareVersionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ServerFirmwareVersion - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ServerFirmwareVersion' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexServerFirmwareVersionByMoid: operationId: GetHyperflexServerFirmwareVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerFirmwareVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ServerFirmwareVersion' resource. operationId: UpdateHyperflexServerFirmwareVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.ServerFirmwareVersion parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ServerFirmwareVersion' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ServerFirmwareVersion' resource was modified as requested. The 'hyperflex.ServerFirmwareVersion' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' links: GetHyperflexServerFirmwareVersionByMoid: operationId: GetHyperflexServerFirmwareVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerFirmwareVersions/{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 'hyperflex.ServerFirmwareVersion' resource is asynchronously being modified 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/hyperflex.ServerFirmwareVersion' links: GetHyperflexServerFirmwareVersionByMoid: operationId: GetHyperflexServerFirmwareVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerFirmwareVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ServerFirmwareVersion' resource. operationId: PatchHyperflexServerFirmwareVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.ServerFirmwareVersion parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ServerFirmwareVersion' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ServerFirmwareVersion' resource was patched as requested. The 'hyperflex.ServerFirmwareVersion' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' links: GetHyperflexServerFirmwareVersionByMoid: operationId: GetHyperflexServerFirmwareVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerFirmwareVersions/{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 'hyperflex.ServerFirmwareVersion' resource is asynchronously being patched 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/hyperflex.ServerFirmwareVersion' links: GetHyperflexServerFirmwareVersionByMoid: operationId: GetHyperflexServerFirmwareVersionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerFirmwareVersions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ServerFirmwareVersion' resource. operationId: DeleteHyperflexServerFirmwareVersion security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ServerFirmwareVersion 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/ServerModels: get: tags: - hyperflex summary: Read a 'hyperflex.ServerModel' resource. operationId: GetHyperflexServerModelList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ServerModel - 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 'hyperflex.ServerModel' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.ServerModel.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.ServerModel' resource. operationId: CreateHyperflexServerModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.ServerModel parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.ServerModel' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerModel' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ServerModel' resource was created as requested. The 'hyperflex.ServerModel' 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/hyperflex.ServerModel' links: GetHyperflexServerModelByMoid: operationId: GetHyperflexServerModelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerModels/{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 'hyperflex.ServerModel' 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/hyperflex.ServerModel' links: GetHyperflexServerModelByMoid: operationId: GetHyperflexServerModelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerModels/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/ServerModels/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.ServerModel' resource. operationId: GetHyperflexServerModelByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.ServerModel - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.ServerModel' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerModel' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexServerModelByMoid: operationId: GetHyperflexServerModelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerModels/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.ServerModel' resource. operationId: UpdateHyperflexServerModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.ServerModel parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ServerModel' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ServerModel' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ServerModel' resource was modified as requested. The 'hyperflex.ServerModel' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerModel' links: GetHyperflexServerModelByMoid: operationId: GetHyperflexServerModelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerModels/{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 'hyperflex.ServerModel' resource is asynchronously being modified 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/hyperflex.ServerModel' links: GetHyperflexServerModelByMoid: operationId: GetHyperflexServerModelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerModels/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.ServerModel' resource. operationId: PatchHyperflexServerModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.hyperflex.ServerModel parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.ServerModel' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.ServerModel' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.ServerModel' resource was patched as requested. The 'hyperflex.ServerModel' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.ServerModel' links: GetHyperflexServerModelByMoid: operationId: GetHyperflexServerModelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerModels/{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 'hyperflex.ServerModel' resource is asynchronously being patched 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/hyperflex.ServerModel' links: GetHyperflexServerModelByMoid: operationId: GetHyperflexServerModelByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/ServerModels/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.ServerModel' resource. operationId: DeleteHyperflexServerModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.ServerModel 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/SoftwareVersionPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.SoftwareVersionPolicy' resource. operationId: GetHyperflexSoftwareVersionPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.SoftwareVersionPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.SoftwareVersionPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.SoftwareVersionPolicy' resource. operationId: CreateHyperflexSoftwareVersionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.SoftwareVersionPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.SoftwareVersionPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.SoftwareVersionPolicy' resource was created as requested. The 'hyperflex.SoftwareVersionPolicy' 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/hyperflex.SoftwareVersionPolicy' links: GetHyperflexSoftwareVersionPolicyByMoid: operationId: GetHyperflexSoftwareVersionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SoftwareVersionPolicies/{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 'hyperflex.SoftwareVersionPolicy' 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/hyperflex.SoftwareVersionPolicy' links: GetHyperflexSoftwareVersionPolicyByMoid: operationId: GetHyperflexSoftwareVersionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SoftwareVersionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/SoftwareVersionPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.SoftwareVersionPolicy' resource. operationId: GetHyperflexSoftwareVersionPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.SoftwareVersionPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.SoftwareVersionPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexSoftwareVersionPolicyByMoid: operationId: GetHyperflexSoftwareVersionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SoftwareVersionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.SoftwareVersionPolicy' resource. operationId: UpdateHyperflexSoftwareVersionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.SoftwareVersionPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.SoftwareVersionPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.SoftwareVersionPolicy' resource was modified as requested. The 'hyperflex.SoftwareVersionPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' links: GetHyperflexSoftwareVersionPolicyByMoid: operationId: GetHyperflexSoftwareVersionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SoftwareVersionPolicies/{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 'hyperflex.SoftwareVersionPolicy' resource is asynchronously being modified 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/hyperflex.SoftwareVersionPolicy' links: GetHyperflexSoftwareVersionPolicyByMoid: operationId: GetHyperflexSoftwareVersionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SoftwareVersionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.SoftwareVersionPolicy' resource. operationId: PatchHyperflexSoftwareVersionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.SoftwareVersionPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.SoftwareVersionPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.SoftwareVersionPolicy' resource was patched as requested. The 'hyperflex.SoftwareVersionPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' links: GetHyperflexSoftwareVersionPolicyByMoid: operationId: GetHyperflexSoftwareVersionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SoftwareVersionPolicies/{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 'hyperflex.SoftwareVersionPolicy' resource is asynchronously being patched 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/hyperflex.SoftwareVersionPolicy' links: GetHyperflexSoftwareVersionPolicyByMoid: operationId: GetHyperflexSoftwareVersionPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SoftwareVersionPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.SoftwareVersionPolicy' resource. operationId: DeleteHyperflexSoftwareVersionPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.SoftwareVersionPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/SysConfigPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.SysConfigPolicy' resource. operationId: GetHyperflexSysConfigPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.SysConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.SysConfigPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.SysConfigPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.SysConfigPolicy' resource. operationId: CreateHyperflexSysConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.SysConfigPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.SysConfigPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.SysConfigPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.SysConfigPolicy' resource was created as requested. The 'hyperflex.SysConfigPolicy' 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/hyperflex.SysConfigPolicy' links: GetHyperflexSysConfigPolicyByMoid: operationId: GetHyperflexSysConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SysConfigPolicies/{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 'hyperflex.SysConfigPolicy' 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/hyperflex.SysConfigPolicy' links: GetHyperflexSysConfigPolicyByMoid: operationId: GetHyperflexSysConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SysConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/SysConfigPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.SysConfigPolicy' resource. operationId: GetHyperflexSysConfigPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.SysConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.SysConfigPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.SysConfigPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexSysConfigPolicyByMoid: operationId: GetHyperflexSysConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SysConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.SysConfigPolicy' resource. operationId: UpdateHyperflexSysConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.SysConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.SysConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.SysConfigPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.SysConfigPolicy' resource was modified as requested. The 'hyperflex.SysConfigPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.SysConfigPolicy' links: GetHyperflexSysConfigPolicyByMoid: operationId: GetHyperflexSysConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SysConfigPolicies/{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 'hyperflex.SysConfigPolicy' resource is asynchronously being modified 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/hyperflex.SysConfigPolicy' links: GetHyperflexSysConfigPolicyByMoid: operationId: GetHyperflexSysConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SysConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.SysConfigPolicy' resource. operationId: PatchHyperflexSysConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.SysConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.SysConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.SysConfigPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.SysConfigPolicy' resource was patched as requested. The 'hyperflex.SysConfigPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.SysConfigPolicy' links: GetHyperflexSysConfigPolicyByMoid: operationId: GetHyperflexSysConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SysConfigPolicies/{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 'hyperflex.SysConfigPolicy' resource is asynchronously being patched 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/hyperflex.SysConfigPolicy' links: GetHyperflexSysConfigPolicyByMoid: operationId: GetHyperflexSysConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/SysConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.SysConfigPolicy' resource. operationId: DeleteHyperflexSysConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.SysConfigPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/UcsmConfigPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.UcsmConfigPolicy' resource. operationId: GetHyperflexUcsmConfigPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.UcsmConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.UcsmConfigPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.UcsmConfigPolicy' resource. operationId: CreateHyperflexUcsmConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.UcsmConfigPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.UcsmConfigPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.UcsmConfigPolicy' resource was created as requested. The 'hyperflex.UcsmConfigPolicy' 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/hyperflex.UcsmConfigPolicy' links: GetHyperflexUcsmConfigPolicyByMoid: operationId: GetHyperflexUcsmConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/UcsmConfigPolicies/{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 'hyperflex.UcsmConfigPolicy' 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/hyperflex.UcsmConfigPolicy' links: GetHyperflexUcsmConfigPolicyByMoid: operationId: GetHyperflexUcsmConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/UcsmConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/UcsmConfigPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.UcsmConfigPolicy' resource. operationId: GetHyperflexUcsmConfigPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.UcsmConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.UcsmConfigPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexUcsmConfigPolicyByMoid: operationId: GetHyperflexUcsmConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/UcsmConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.UcsmConfigPolicy' resource. operationId: UpdateHyperflexUcsmConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.UcsmConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.UcsmConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.UcsmConfigPolicy' resource was modified as requested. The 'hyperflex.UcsmConfigPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' links: GetHyperflexUcsmConfigPolicyByMoid: operationId: GetHyperflexUcsmConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/UcsmConfigPolicies/{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 'hyperflex.UcsmConfigPolicy' resource is asynchronously being modified 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/hyperflex.UcsmConfigPolicy' links: GetHyperflexUcsmConfigPolicyByMoid: operationId: GetHyperflexUcsmConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/UcsmConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.UcsmConfigPolicy' resource. operationId: PatchHyperflexUcsmConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.UcsmConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.UcsmConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.UcsmConfigPolicy' resource was patched as requested. The 'hyperflex.UcsmConfigPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' links: GetHyperflexUcsmConfigPolicyByMoid: operationId: GetHyperflexUcsmConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/UcsmConfigPolicies/{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 'hyperflex.UcsmConfigPolicy' resource is asynchronously being patched 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/hyperflex.UcsmConfigPolicy' links: GetHyperflexUcsmConfigPolicyByMoid: operationId: GetHyperflexUcsmConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/UcsmConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.UcsmConfigPolicy' resource. operationId: DeleteHyperflexUcsmConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.UcsmConfigPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/hyperflex/VcenterConfigPolicies: get: tags: - hyperflex summary: Read a 'hyperflex.VcenterConfigPolicy' resource. operationId: GetHyperflexVcenterConfigPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.VcenterConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'hyperflex.VcenterConfigPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Create a 'hyperflex.VcenterConfigPolicy' resource. operationId: CreateHyperflexVcenterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.hyperflex.VcenterConfigPolicy - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'hyperflex.VcenterConfigPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.VcenterConfigPolicy' resource was created as requested. The 'hyperflex.VcenterConfigPolicy' 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/hyperflex.VcenterConfigPolicy' links: GetHyperflexVcenterConfigPolicyByMoid: operationId: GetHyperflexVcenterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/VcenterConfigPolicies/{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 'hyperflex.VcenterConfigPolicy' 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/hyperflex.VcenterConfigPolicy' links: GetHyperflexVcenterConfigPolicyByMoid: operationId: GetHyperflexVcenterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/VcenterConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/hyperflex/VcenterConfigPolicies/{Moid}: get: tags: - hyperflex summary: Read a 'hyperflex.VcenterConfigPolicy' resource. operationId: GetHyperflexVcenterConfigPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - PRIVSET.Read-Only - PRIVSET.View HyperFlex Cluster Profiles - READ.hyperflex.VcenterConfigPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'hyperflex.VcenterConfigPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetHyperflexVcenterConfigPolicyByMoid: operationId: GetHyperflexVcenterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/VcenterConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - hyperflex summary: Update a 'hyperflex.VcenterConfigPolicy' resource. operationId: UpdateHyperflexVcenterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.VcenterConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.VcenterConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.VcenterConfigPolicy' resource was modified as requested. The 'hyperflex.VcenterConfigPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' links: GetHyperflexVcenterConfigPolicyByMoid: operationId: GetHyperflexVcenterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/VcenterConfigPolicies/{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 'hyperflex.VcenterConfigPolicy' resource is asynchronously being modified 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/hyperflex.VcenterConfigPolicy' links: GetHyperflexVcenterConfigPolicyByMoid: operationId: GetHyperflexVcenterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/VcenterConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - hyperflex summary: Update a 'hyperflex.VcenterConfigPolicy' resource. operationId: PatchHyperflexVcenterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage HyperFlex Cluster Profiles - ROLE.Account Administrator - UPDATE.hyperflex.VcenterConfigPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'hyperflex.VcenterConfigPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'hyperflex.VcenterConfigPolicy' resource was patched as requested. The 'hyperflex.VcenterConfigPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' links: GetHyperflexVcenterConfigPolicyByMoid: operationId: GetHyperflexVcenterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/VcenterConfigPolicies/{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 'hyperflex.VcenterConfigPolicy' resource is asynchronously being patched 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/hyperflex.VcenterConfigPolicy' links: GetHyperflexVcenterConfigPolicyByMoid: operationId: GetHyperflexVcenterConfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hyperflex/VcenterConfigPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - hyperflex summary: Delete a 'hyperflex.VcenterConfigPolicy' resource. operationId: DeleteHyperflexVcenterConfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.hyperflex.VcenterConfigPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/iaas/ConnectorPacks: get: tags: - iaas summary: Read a 'iaas.ConnectorPack' resource. operationId: GetIaasConnectorPackList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.ConnectorPack parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.ConnectorPack' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.ConnectorPack.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/ConnectorPacks/{Moid}: get: tags: - iaas summary: Read a 'iaas.ConnectorPack' resource. operationId: GetIaasConnectorPackByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.ConnectorPack parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.ConnectorPack' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.ConnectorPack' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasConnectorPackByMoid: operationId: GetIaasConnectorPackByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/ConnectorPacks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/DeviceStatuses: get: tags: - iaas summary: Read a 'iaas.DeviceStatus' resource. operationId: GetIaasDeviceStatusList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.DeviceStatus parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.DeviceStatus' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.DeviceStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/DeviceStatuses/{Moid}: get: tags: - iaas summary: Read a 'iaas.DeviceStatus' resource. operationId: GetIaasDeviceStatusByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.DeviceStatus parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.DeviceStatus' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.DeviceStatus' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasDeviceStatusByMoid: operationId: GetIaasDeviceStatusByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/DeviceStatuses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/DiagnosticMessages: get: tags: - iaas summary: Read a 'iaas.DiagnosticMessages' resource. operationId: GetIaasDiagnosticMessagesList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.DiagnosticMessages parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.DiagnosticMessages' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.DiagnosticMessages.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/DiagnosticMessages/{Moid}: get: tags: - iaas summary: Read a 'iaas.DiagnosticMessages' resource. operationId: GetIaasDiagnosticMessagesByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.DiagnosticMessages parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.DiagnosticMessages' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.DiagnosticMessages' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasDiagnosticMessagesByMoid: operationId: GetIaasDiagnosticMessagesByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/DiagnosticMessages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/LicenseInfos: get: tags: - iaas summary: Read a 'iaas.LicenseInfo' resource. operationId: GetIaasLicenseInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.LicenseInfo parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.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: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.LicenseInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/LicenseInfos/{Moid}: get: tags: - iaas summary: Read a 'iaas.LicenseInfo' resource. operationId: GetIaasLicenseInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.LicenseInfo parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.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/iaas.LicenseInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasLicenseInfoByMoid: operationId: GetIaasLicenseInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/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/iaas/MostRunTasks: get: tags: - iaas summary: Read a 'iaas.MostRunTasks' resource. operationId: GetIaasMostRunTasksList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.MostRunTasks parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.MostRunTasks' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.MostRunTasks.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/MostRunTasks/{Moid}: get: tags: - iaas summary: Read a 'iaas.MostRunTasks' resource. operationId: GetIaasMostRunTasksByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.MostRunTasks parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.MostRunTasks' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.MostRunTasks' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasMostRunTasksByMoid: operationId: GetIaasMostRunTasksByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/MostRunTasks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/ServiceRequests: get: tags: - iaas summary: Read a 'iaas.ServiceRequest' resource. operationId: GetIaasServiceRequestList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.ServiceRequest parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.ServiceRequest' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.ServiceRequest.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/ServiceRequests/{Moid}: get: tags: - iaas summary: Read a 'iaas.ServiceRequest' resource. operationId: GetIaasServiceRequestByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.ServiceRequest parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.ServiceRequest' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.ServiceRequest' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasServiceRequestByMoid: operationId: GetIaasServiceRequestByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/ServiceRequests/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/UcsdInfos: get: tags: - iaas summary: Read a 'iaas.UcsdInfo' resource. operationId: GetIaasUcsdInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.iaas.UcsdInfo - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.UcsdInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.UcsdInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/UcsdInfos/{Moid}: get: tags: - iaas summary: Read a 'iaas.UcsdInfo' resource. operationId: GetIaasUcsdInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.iaas.UcsdInfo - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.UcsdInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.UcsdInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasUcsdInfoByMoid: operationId: GetIaasUcsdInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - iaas summary: Delete a 'iaas.UcsdInfo' resource. operationId: DeleteIaasUcsdInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.iaas.UcsdInfo 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - iaas summary: Update a 'iaas.UcsdInfo' resource. operationId: UpdateIaasUcsdInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.iaas.UcsdInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iaas.UcsdInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iaas.UcsdInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'iaas.UcsdInfo' resource was modified as requested. The 'iaas.UcsdInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/iaas.UcsdInfo' links: GetIaasUcsdInfoByMoid: operationId: GetIaasUcsdInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{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 'iaas.UcsdInfo' resource is asynchronously being modified 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/iaas.UcsdInfo' links: GetIaasUcsdInfoByMoid: operationId: GetIaasUcsdInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - iaas summary: Update a 'iaas.UcsdInfo' resource. operationId: PatchIaasUcsdInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.iaas.UcsdInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iaas.UcsdInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iaas.UcsdInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'iaas.UcsdInfo' resource was patched as requested. The 'iaas.UcsdInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/iaas.UcsdInfo' links: GetIaasUcsdInfoByMoid: operationId: GetIaasUcsdInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{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 'iaas.UcsdInfo' resource is asynchronously being patched 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/iaas.UcsdInfo' links: GetIaasUcsdInfoByMoid: operationId: GetIaasUcsdInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/UcsdManagedInfras: get: tags: - iaas summary: Read a 'iaas.UcsdManagedInfra' resource. operationId: GetIaasUcsdManagedInfraList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.UcsdManagedInfra parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.UcsdManagedInfra' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.UcsdManagedInfra.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/UcsdManagedInfras/{Moid}: get: tags: - iaas summary: Read a 'iaas.UcsdManagedInfra' resource. operationId: GetIaasUcsdManagedInfraByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.UcsdManagedInfra parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.UcsdManagedInfra' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.UcsdManagedInfra' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasUcsdManagedInfraByMoid: operationId: GetIaasUcsdManagedInfraByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdManagedInfras/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/UcsdMessages: get: tags: - iaas summary: Read a 'iaas.UcsdMessages' resource. operationId: GetIaasUcsdMessagesList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.UcsdMessages parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'iaas.UcsdMessages' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/iaas.UcsdMessages.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/iaas/UcsdMessages/{Moid}: get: tags: - iaas summary: Read a 'iaas.UcsdMessages' resource. operationId: GetIaasUcsdMessagesByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iaas.UcsdMessages parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'iaas.UcsdMessages' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/iaas.UcsdMessages' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIaasUcsdMessagesByMoid: operationId: GetIaasUcsdMessagesByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdMessages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Account.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Account' 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/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: - READ.iam.Account parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: - UPDATE.iam.Account parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.Account' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.Account' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Account' resource is asynchronously being modified 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/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: - UPDATE.iam.Account parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.Account' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Account' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.AccountExperience.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.AccountExperience' resource. operationId: CreateIamAccountExperience security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.iam.AccountExperience parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'iam.AccountExperience' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/iam.AccountExperience' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'iam.AccountExperience' resource was created as requested. The 'iam.AccountExperience' 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.AccountExperience' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.AccountExperience' 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/iam.AccountExperience' 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/AccountExperiences/{Moid}: get: tags: - iam summary: Read a 'iam.AccountExperience' resource. operationId: GetIamAccountExperienceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iam.AccountExperience parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage API Keys - PRIVSET.Read-Only - READ.iam.ApiKey - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.ApiKey.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage API Keys - PRIVSET.Read-Only - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.ApiKey' 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/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.Manage API Keys - PRIVSET.Read-Only - READ.iam.ApiKey - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage API Keys - PRIVSET.Read-Only - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.Manage API Keys - PRIVSET.Read-Only - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer - UPDATE.iam.ApiKey parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.ApiKey' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.ApiKey' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.ApiKey' resource is asynchronously being modified 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/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.Manage API Keys - PRIVSET.Read-Only - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer - UPDATE.iam.ApiKey parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.ApiKey' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.ApiKey' resource is asynchronously being patched 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/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: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.AppRegistration.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.AppRegistration' 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/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: - READ.iam.AppRegistration parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - UPDATE.iam.AppRegistration parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.AppRegistration' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.AppRegistration' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.AppRegistration' resource is asynchronously being modified 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/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: - UPDATE.iam.AppRegistration parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.AppRegistration' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.AppRegistration' resource is asynchronously being patched 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/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/Certificates: get: tags: - iam summary: Read a 'iam.Certificate' resource. operationId: GetIamCertificateList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Certificate.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 - 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Certificate' 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/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 - READ.iam.Certificate - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.Certificate' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Certificate' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Certificate' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.CertificateRequest.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.CertificateRequest' 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/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 - READ.iam.CertificateRequest - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.CertificateRequest' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.CertificateRequest' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.CertificateRequest' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/DomainGroups: get: tags: - iam 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.DomainGroup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'iam.DomainGroup' resource. operationId: GetIamDomainGroupByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iam.DomainGroup parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/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 - READ.iam.EndPointPrivilege - 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.EndPointPrivilege.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 - READ.iam.EndPointPrivilege - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Access and Permissions - PRIVSET.Manage Server Profiles - PRIVSET.View Server Profiles - READ.iam.EndPointRole - ROLE.Account 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.EndPointRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Access and Permissions - PRIVSET.Manage Server Profiles - PRIVSET.View Server Profiles - READ.iam.EndPointRole - ROLE.Account Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.View Server Profiles - READ.iam.EndPointUser - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.EndPointUser.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUser' 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/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.View Server Profiles - READ.iam.EndPointUser - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.EndPointUser' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUser' resource is asynchronously being modified 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/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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUser' resource is asynchronously being patched 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/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.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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.Read-Only - PRIVSET.View Server Profiles - READ.iam.EndPointUserPolicy - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.EndPointUserPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Server 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUserPolicy' 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/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.Read-Only - PRIVSET.View Server Profiles - READ.iam.EndPointUserPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.EndPointUserPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUserPolicy' resource is asynchronously being modified 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/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.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUserPolicy' resource is asynchronously being patched 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/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.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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.View Server Profiles - READ.iam.EndPointUserRole - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.EndPointUserRole.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUserRole' 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/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.View Server Profiles - READ.iam.EndPointUserRole - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.EndPointUserRole' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUserRole' resource is asynchronously being modified 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/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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.EndPointUserRole' resource is asynchronously being patched 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/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.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.Manage Access and Permissions - PRIVSET.Manage Identity Providers - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Idp.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Idp' 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/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.Manage Access and Permissions - PRIVSET.Manage Identity Providers - READ.iam.Idp - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.Idp' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Idp' resource is asynchronously being modified 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/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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Idp' resource is asynchronously being patched 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/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.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.Manage Access and Permissions - PRIVSET.Manage Identity Providers - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.IdpReference.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Access and Permissions - PRIVSET.Manage Identity Providers - READ.iam.IdpReference - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.IdpReference' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IdpReference' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IdpReference' resource is asynchronously being patched 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/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.Manage Access and Permissions - PRIVSET.Manage Sessions - READ.iam.IpAccessManagement - 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.IpAccessManagement.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 - ROLE.User Access 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IpAccessManagement' 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/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.Manage Access and Permissions - PRIVSET.Manage Sessions - READ.iam.IpAccessManagement - ROLE.Account Administrator - ROLE.User Access Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - ROLE.User Access Administrator - UPDATE.iam.IpAccessManagement parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.IpAccessManagement' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.IpAccessManagement' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IpAccessManagement' resource is asynchronously being modified 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/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 - ROLE.User Access Administrator - UPDATE.iam.IpAccessManagement parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.IpAccessManagement' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IpAccessManagement' resource is asynchronously being patched 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/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.Manage Access and Permissions - PRIVSET.Manage Sessions - READ.iam.IpAddress - 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.IpAddress.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Access and Permissions - PRIVSET.Manage Sessions - ROLE.Account Administrator - ROLE.User Access 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IpAddress' 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/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.Manage Access and Permissions - PRIVSET.Manage Sessions - READ.iam.IpAddress - ROLE.Account Administrator - ROLE.User Access Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Access and Permissions - PRIVSET.Manage Sessions - ROLE.Account Administrator - ROLE.User Access Administrator - UPDATE.iam.IpAddress parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.IpAddress' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.IpAddress' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IpAddress' resource is asynchronously being modified 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/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.Manage Access and Permissions - PRIVSET.Manage Sessions - ROLE.Account Administrator - ROLE.User Access Administrator - UPDATE.iam.IpAddress parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.IpAddress' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.IpAddress' resource is asynchronously being patched 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/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.Manage Access and Permissions - PRIVSET.Manage Sessions - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/LdapGroups: post: tags: - iam summary: Create a 'iam.LdapGroup' resource. operationId: CreateIamLdapGroup security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.iam.LdapGroup - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - PRIVSET.Manage Server 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapGroup' 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/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.Read-Only - PRIVSET.View Server Profiles - READ.iam.LdapGroup - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.LdapGroup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Read-Only - PRIVSET.View Server Profiles - READ.iam.LdapGroup - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Access and Permissions - PRIVSET.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.LdapGroup' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapGroup' resource is asynchronously being modified 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/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.Manage Access and Permissions - PRIVSET.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapGroup' resource is asynchronously being patched 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/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.Manage Access and Permissions - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/LdapPolicies: post: tags: - iam summary: Create a 'iam.LdapPolicy' resource. operationId: CreateIamLdapPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.iam.LdapPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - PRIVSET.Manage Server 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapPolicy' 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/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.Read-Only - PRIVSET.View Server Profiles - READ.iam.LdapPolicy - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.LdapPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Read-Only - PRIVSET.View Server Profiles - READ.iam.LdapPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Access and Permissions - PRIVSET.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.LdapPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapPolicy' resource is asynchronously being modified 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/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.Manage Access and Permissions - PRIVSET.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapPolicy' resource is asynchronously being patched 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/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.Manage Access and Permissions - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/LdapProviders: post: tags: - iam summary: Create a 'iam.LdapProvider' resource. operationId: CreateIamLdapProvider security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.iam.LdapProvider - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - PRIVSET.Manage Server 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapProvider' 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/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.Manage Access and Permissions - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.iam.LdapProvider - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.LdapProvider.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Access and Permissions - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.iam.LdapProvider - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Access and Permissions - PRIVSET.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.LdapProvider' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapProvider' resource is asynchronously being modified 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/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.Manage Access and Permissions - PRIVSET.Manage Server 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LdapProvider' resource is asynchronously being patched 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/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.Manage Access and Permissions - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/LocalUserPasswords/{Moid}: post: tags: - iam summary: Update a 'iam.LocalUserPassword' resource. operationId: UpdateIamLocalUserPassword security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - ROLE.Account Administrator - UPDATE.iam.LocalUserPassword parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.LocalUserPassword' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.LocalUserPassword' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LocalUserPassword' resource is asynchronously being modified 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/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.Account Administrator - PRIVSET.Manage Access and Permissions - ROLE.Account Administrator - UPDATE.iam.LocalUserPassword parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.LocalUserPassword' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.LocalUserPassword' resource is asynchronously being patched 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/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/OAuthTokens: get: tags: - iam summary: Read a 'iam.OAuthToken' resource. operationId: GetIamOAuthTokenList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Auth Tokens - PRIVSET.Read-Only - READ.iam.OAuthToken - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.OAuthToken.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Auth Tokens - PRIVSET.Read-Only - READ.iam.OAuthToken - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Auth Tokens - PRIVSET.Read-Only - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/Permissions: post: tags: - iam 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Permission' 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/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 summary: Read a 'iam.Permission' resource. operationId: GetIamPermissionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Permission.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.Permission' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Permission' resource is asynchronously being modified 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/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Permission' resource is asynchronously being patched 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/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 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 summary: Read a 'iam.Permission' resource. operationId: GetIamPermissionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - READ.iam.Permission - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.PrivateKeySpec.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.PrivateKeySpec' 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/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 - READ.iam.PrivateKeySpec - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.PrivateKeySpec' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.PrivateKeySpec' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.PrivateKeySpec' resource is asynchronously being patched 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/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 - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 summary: Read a 'iam.Privilege' resource. operationId: GetIamPrivilegeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Privilege.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'iam.Privilege' resource. operationId: GetIamPrivilegeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - READ.iam.Privilege - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 summary: Read a 'iam.PrivilegeSet' resource. operationId: GetIamPrivilegeSetList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - READ.iam.PrivilegeSet - 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.PrivilegeSet.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'iam.PrivilegeSet' resource. operationId: GetIamPrivilegeSetByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - READ.iam.PrivilegeSet - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' /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 - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Qualifier.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Qualifier' 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/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 - READ.iam.Qualifier - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.Qualifier' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Qualifier' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.Qualifier' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.Manage Sessions - READ.iam.ResourceLimits - 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.ResourceLimits.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Sessions - READ.iam.ResourceLimits - ROLE.Account Administrator - ROLE.User Access Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' /api/v1/iam/ResourcePermissions: get: tags: - iam 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.ResourcePermission.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'iam.ResourcePermission' resource. operationId: GetIamResourcePermissionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.iam.ResourcePermission parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.ResourceRoles.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.ResourceRoles' 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/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 - READ.iam.ResourceRoles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.ResourceRoles' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.ResourceRoles' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.ResourceRoles' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 summary: Read a 'iam.Role' resource. operationId: GetIamRoleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Role.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'iam.Role' resource. operationId: GetIamRoleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - READ.iam.Role - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.SecurityHolder.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 - READ.iam.SecurityHolder - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.ServiceProvider.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - READ.iam.Session - 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.Session.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 - READ.iam.Session - ROLE.Account Administrator - ROLE.User Access Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.Manage Sessions - READ.iam.SessionLimits - 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.SessionLimits.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 - ROLE.User Access 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.SessionLimits' 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/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.Manage Sessions - READ.iam.SessionLimits - ROLE.Account Administrator - ROLE.User Access Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Manage Access and Permissions - PRIVSET.Manage Sessions - ROLE.Account Administrator - ROLE.User Access Administrator - UPDATE.iam.SessionLimits parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.SessionLimits' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.SessionLimits' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.SessionLimits' resource is asynchronously being modified 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/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.Manage Access and Permissions - PRIVSET.Manage Sessions - ROLE.Account Administrator - ROLE.User Access Administrator - UPDATE.iam.SessionLimits parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.SessionLimits' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.SessionLimits' resource is asynchronously being patched 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/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 - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.System.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/TrustPoints: get: tags: - iam summary: Read a 'iam.TrustPoint' resource. operationId: GetIamTrustPointList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Access and Permissions - PRIVSET.Manage Identity Providers - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.TrustPoint.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.TrustPoint' 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/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.Manage Access and Permissions - PRIVSET.Manage Identity Providers - READ.iam.TrustPoint - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.Manage Access and Permissions - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.User.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.User' 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/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.Manage Access and Permissions - READ.iam.User - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.User' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.User' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.User' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.UserGroup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.UserGroup' 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/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 - READ.iam.UserGroup - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.UserGroup' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.UserGroup' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.UserGroup' resource is asynchronously being patched 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/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: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/iam.UserPreference.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: - READ.iam.UserPreference parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: - UPDATE.iam.UserPreference parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.UserPreference' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/iam.UserPreference' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.UserPreference' resource is asynchronously being modified 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/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: - UPDATE.iam.UserPreference parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'iam.UserPreference' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'iam.UserPreference' resource is asynchronously being patched 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/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/inventory/DeviceInfos: get: tags: - inventory summary: Read a 'inventory.DeviceInfo' resource. operationId: GetInventoryDeviceInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.inventory.DeviceInfo parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'inventory.DeviceInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/inventory.DeviceInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/DeviceInfos/{Moid}: get: tags: - inventory summary: Read a 'inventory.DeviceInfo' resource. operationId: GetInventoryDeviceInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.inventory.DeviceInfo parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'inventory.DeviceInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/inventory.DeviceInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetInventoryDeviceInfoByMoid: operationId: GetInventoryDeviceInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/DeviceInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/DnMoBindings: get: tags: - inventory summary: Read a 'inventory.DnMoBinding' resource. operationId: GetInventoryDnMoBindingList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.inventory.DnMoBinding parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'inventory.DnMoBinding' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/inventory.DnMoBinding.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/DnMoBindings/{Moid}: get: tags: - inventory summary: Read a 'inventory.DnMoBinding' resource. operationId: GetInventoryDnMoBindingByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.inventory.DnMoBinding parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'inventory.DnMoBinding' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/inventory.DnMoBinding' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetInventoryDnMoBindingByMoid: operationId: GetInventoryDnMoBindingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/DnMoBindings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/GenericInventories: get: tags: - inventory summary: Read a 'inventory.GenericInventory' resource. operationId: GetInventoryGenericInventoryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.inventory.GenericInventory - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'inventory.GenericInventory' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/inventory.GenericInventory.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/GenericInventories/{Moid}: get: tags: - inventory summary: Read a 'inventory.GenericInventory' resource. operationId: GetInventoryGenericInventoryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.inventory.GenericInventory - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'inventory.GenericInventory' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/inventory.GenericInventory' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetInventoryGenericInventoryByMoid: operationId: GetInventoryGenericInventoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - inventory summary: Update a 'inventory.GenericInventory' resource. operationId: UpdateInventoryGenericInventory security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.inventory.GenericInventory parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'inventory.GenericInventory' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/inventory.GenericInventory' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventory' resource was modified as requested. The 'inventory.GenericInventory' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/inventory.GenericInventory' links: GetInventoryGenericInventoryByMoid: operationId: GetInventoryGenericInventoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'inventory.GenericInventory' resource is asynchronously being modified 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/inventory.GenericInventory' links: GetInventoryGenericInventoryByMoid: operationId: GetInventoryGenericInventoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - inventory summary: Update a 'inventory.GenericInventory' resource. operationId: PatchInventoryGenericInventory security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.inventory.GenericInventory parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'inventory.GenericInventory' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/inventory.GenericInventory' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventory' resource was patched as requested. The 'inventory.GenericInventory' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/inventory.GenericInventory' links: GetInventoryGenericInventoryByMoid: operationId: GetInventoryGenericInventoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'inventory.GenericInventory' resource is asynchronously being patched 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/inventory.GenericInventory' links: GetInventoryGenericInventoryByMoid: operationId: GetInventoryGenericInventoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/GenericInventoryHolders: get: tags: - inventory summary: Read a 'inventory.GenericInventoryHolder' resource. operationId: GetInventoryGenericInventoryHolderList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.inventory.GenericInventoryHolder - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'inventory.GenericInventoryHolder' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/inventory.GenericInventoryHolder.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/GenericInventoryHolders/{Moid}: get: tags: - inventory summary: Read a 'inventory.GenericInventoryHolder' resource. operationId: GetInventoryGenericInventoryHolderByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.inventory.GenericInventoryHolder - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'inventory.GenericInventoryHolder' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/inventory.GenericInventoryHolder' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetInventoryGenericInventoryHolderByMoid: operationId: GetInventoryGenericInventoryHolderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - inventory summary: Update a 'inventory.GenericInventoryHolder' resource. operationId: UpdateInventoryGenericInventoryHolder security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.inventory.GenericInventoryHolder parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'inventory.GenericInventoryHolder' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/inventory.GenericInventoryHolder' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventoryHolder' resource was modified as requested. The 'inventory.GenericInventoryHolder' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/inventory.GenericInventoryHolder' links: GetInventoryGenericInventoryHolderByMoid: operationId: GetInventoryGenericInventoryHolderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'inventory.GenericInventoryHolder' resource is asynchronously being modified 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/inventory.GenericInventoryHolder' links: GetInventoryGenericInventoryHolderByMoid: operationId: GetInventoryGenericInventoryHolderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - inventory summary: Update a 'inventory.GenericInventoryHolder' resource. operationId: PatchInventoryGenericInventoryHolder security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.inventory.GenericInventoryHolder parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'inventory.GenericInventoryHolder' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/inventory.GenericInventoryHolder' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventoryHolder' resource was patched as requested. The 'inventory.GenericInventoryHolder' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/inventory.GenericInventoryHolder' links: GetInventoryGenericInventoryHolderByMoid: operationId: GetInventoryGenericInventoryHolderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'inventory.GenericInventoryHolder' resource is asynchronously being patched 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/inventory.GenericInventoryHolder' links: GetInventoryGenericInventoryHolderByMoid: operationId: GetInventoryGenericInventoryHolderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/inventory/Requests: post: tags: - inventory summary: Create a 'inventory.Request' resource. operationId: CreateInventoryRequest security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.inventory.Request parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'inventory.Request' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/inventory.Request' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.Request' resource was created as requested. The 'inventory.Request' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/inventory.Request' links: GetInventoryRequestByMoid: operationId: GetInventoryRequestByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/Requests/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'inventory.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/inventory.Request' links: GetInventoryRequestByMoid: operationId: GetInventoryRequestByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/Requests/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ipmioverlan/Policies: post: tags: - ipmioverlan summary: Create a 'ipmioverlan.Policy' resource. operationId: CreateIpmioverlanPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.ipmioverlan.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'ipmioverlan.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/ipmioverlan.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ipmioverlan.Policy' resource was created as requested. The 'ipmioverlan.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ipmioverlan.Policy' links: GetIpmioverlanPolicyByMoid: operationId: GetIpmioverlanPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ipmioverlan.Policy' 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/ipmioverlan.Policy' links: GetIpmioverlanPolicyByMoid: operationId: GetIpmioverlanPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - ipmioverlan summary: Read a 'ipmioverlan.Policy' resource. operationId: GetIpmioverlanPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.ipmioverlan.Policy - 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 'ipmioverlan.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ipmioverlan.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ipmioverlan/Policies/{Moid}: get: tags: - ipmioverlan summary: Read a 'ipmioverlan.Policy' resource. operationId: GetIpmioverlanPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.ipmioverlan.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ipmioverlan.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ipmioverlan.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIpmioverlanPolicyByMoid: operationId: GetIpmioverlanPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ipmioverlan summary: Update a 'ipmioverlan.Policy' resource. operationId: UpdateIpmioverlanPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.ipmioverlan.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ipmioverlan.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ipmioverlan.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ipmioverlan.Policy' resource was modified as requested. The 'ipmioverlan.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ipmioverlan.Policy' links: GetIpmioverlanPolicyByMoid: operationId: GetIpmioverlanPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ipmioverlan.Policy' resource is asynchronously being modified 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/ipmioverlan.Policy' links: GetIpmioverlanPolicyByMoid: operationId: GetIpmioverlanPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ipmioverlan summary: Update a 'ipmioverlan.Policy' resource. operationId: PatchIpmioverlanPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.ipmioverlan.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ipmioverlan.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ipmioverlan.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 'ipmioverlan.Policy' resource was patched as requested. The 'ipmioverlan.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ipmioverlan.Policy' links: GetIpmioverlanPolicyByMoid: operationId: GetIpmioverlanPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ipmioverlan.Policy' resource is asynchronously being patched 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/ipmioverlan.Policy' links: GetIpmioverlanPolicyByMoid: operationId: GetIpmioverlanPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - ipmioverlan summary: Delete a 'ipmioverlan.Policy' resource. operationId: DeleteIpmioverlanPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.ipmioverlan.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/IpLeases: get: tags: - ippool summary: Read a 'ippool.IpLease' resource. operationId: GetIppoolIpLeaseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.IpLease - 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 'ippool.IpLease' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ippool.IpLease.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ippool summary: Create a 'ippool.IpLease' resource. operationId: CreateIppoolIpLease security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.ippool.IpLease - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - ROLE.Account Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'ippool.IpLease' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/ippool.IpLease' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.IpLease' resource was created as requested. The 'ippool.IpLease' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ippool.IpLease' links: GetIppoolIpLeaseByMoid: operationId: GetIppoolIpLeaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/IpLeases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ippool.IpLease' 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/ippool.IpLease' links: GetIppoolIpLeaseByMoid: operationId: GetIppoolIpLeaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/IpLeases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/IpLeases/{Moid}: get: tags: - ippool summary: Read a 'ippool.IpLease' resource. operationId: GetIppoolIpLeaseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.IpLease - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ippool.IpLease' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ippool.IpLease' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIppoolIpLeaseByMoid: operationId: GetIppoolIpLeaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/IpLeases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - ippool summary: Delete a 'ippool.IpLease' resource. operationId: DeleteIppoolIpLease security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.ippool.IpLease - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - ROLE.Account 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/Pools: get: tags: - ippool summary: Read a 'ippool.Pool' resource. operationId: GetIppoolPoolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.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 'ippool.Pool' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ippool.Pool.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ippool summary: Create a 'ippool.Pool' resource. operationId: CreateIppoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.ippool.Pool - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'ippool.Pool' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/ippool.Pool' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Pool' resource was created as requested. The 'ippool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ippool.Pool' links: GetIppoolPoolByMoid: operationId: GetIppoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ippool.Pool' 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/ippool.Pool' links: GetIppoolPoolByMoid: operationId: GetIppoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/Pools/{Moid}: get: tags: - ippool summary: Read a 'ippool.Pool' resource. operationId: GetIppoolPoolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.Pool - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ippool.Pool' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ippool.Pool' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIppoolPoolByMoid: operationId: GetIppoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ippool summary: Update a 'ippool.Pool' resource. operationId: UpdateIppoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.ippool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ippool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ippool.Pool' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Pool' resource was modified as requested. The 'ippool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ippool.Pool' links: GetIppoolPoolByMoid: operationId: GetIppoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ippool.Pool' resource is asynchronously being modified 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/ippool.Pool' links: GetIppoolPoolByMoid: operationId: GetIppoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ippool summary: Update a 'ippool.Pool' resource. operationId: PatchIppoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.ippool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ippool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ippool.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 'ippool.Pool' resource was patched as requested. The 'ippool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ippool.Pool' links: GetIppoolPoolByMoid: operationId: GetIppoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ippool.Pool' resource is asynchronously being patched 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/ippool.Pool' links: GetIppoolPoolByMoid: operationId: GetIppoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - ippool summary: Delete a 'ippool.Pool' resource. operationId: DeleteIppoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.ippool.Pool - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/PoolMembers: get: tags: - ippool summary: Read a 'ippool.PoolMember' resource. operationId: GetIppoolPoolMemberList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.PoolMember - 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 'ippool.PoolMember' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ippool.PoolMember.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/PoolMembers/{Moid}: get: tags: - ippool summary: Read a 'ippool.PoolMember' resource. operationId: GetIppoolPoolMemberByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.PoolMember - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ippool.PoolMember' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ippool.PoolMember' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIppoolPoolMemberByMoid: operationId: GetIppoolPoolMemberByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/PoolMembers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/ShadowBlocks: get: tags: - ippool summary: Read a 'ippool.ShadowBlock' resource. operationId: GetIppoolShadowBlockList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.ShadowBlock - 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 'ippool.ShadowBlock' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ippool.ShadowBlock.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/ShadowBlocks/{Moid}: get: tags: - ippool summary: Read a 'ippool.ShadowBlock' resource. operationId: GetIppoolShadowBlockByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.ShadowBlock - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ippool.ShadowBlock' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ippool.ShadowBlock' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIppoolShadowBlockByMoid: operationId: GetIppoolShadowBlockByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/ShadowBlocks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/ShadowPools: get: tags: - ippool summary: Read a 'ippool.ShadowPool' resource. operationId: GetIppoolShadowPoolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.ShadowPool - 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 'ippool.ShadowPool' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ippool.ShadowPool.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/ShadowPools/{Moid}: get: tags: - ippool summary: Read a 'ippool.ShadowPool' resource. operationId: GetIppoolShadowPoolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.ShadowPool - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ippool.ShadowPool' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ippool.ShadowPool' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIppoolShadowPoolByMoid: operationId: GetIppoolShadowPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/ShadowPools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/Universes: get: tags: - ippool summary: Read a 'ippool.Universe' resource. operationId: GetIppoolUniverseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.Universe - 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 'ippool.Universe' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ippool.Universe.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ippool/Universes/{Moid}: get: tags: - ippool summary: Read a 'ippool.Universe' resource. operationId: GetIppoolUniverseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ippool.Universe - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ippool.Universe' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ippool.Universe' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetIppoolUniverseByMoid: operationId: GetIppoolUniverseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Universes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/kvm/KvmSessions: get: tags: - kvm summary: Read a 'kvm.KvmSession' resource. operationId: GetKvmKvmSessionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - READ.kvm.KvmSession - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'kvm.KvmSession' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/kvm.KvmSession.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/kvm/KvmSessions/{Moid}: get: tags: - kvm summary: Read a 'kvm.KvmSession' resource. operationId: GetKvmKvmSessionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - READ.kvm.KvmSession - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'kvm.KvmSession' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/kvm.KvmSession' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetKvmKvmSessionByMoid: operationId: GetKvmKvmSessionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/KvmSessions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/kvm/Policies: get: tags: - kvm summary: Read a 'kvm.Policy' resource. operationId: GetKvmPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.kvm.Policy - 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 'kvm.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/kvm.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - kvm summary: Create a 'kvm.Policy' resource. operationId: CreateKvmPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.kvm.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'kvm.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/kvm.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Policy' resource was created as requested. The 'kvm.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/kvm.Policy' links: GetKvmPolicyByMoid: operationId: GetKvmPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'kvm.Policy' 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/kvm.Policy' links: GetKvmPolicyByMoid: operationId: GetKvmPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/kvm/Policies/{Moid}: get: tags: - kvm summary: Read a 'kvm.Policy' resource. operationId: GetKvmPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.kvm.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'kvm.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/kvm.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetKvmPolicyByMoid: operationId: GetKvmPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - kvm summary: Update a 'kvm.Policy' resource. operationId: UpdateKvmPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.kvm.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'kvm.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/kvm.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Policy' resource was modified as requested. The 'kvm.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/kvm.Policy' links: GetKvmPolicyByMoid: operationId: GetKvmPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'kvm.Policy' resource is asynchronously being modified 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/kvm.Policy' links: GetKvmPolicyByMoid: operationId: GetKvmPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - kvm summary: Update a 'kvm.Policy' resource. operationId: PatchKvmPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.kvm.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'kvm.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/kvm.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 'kvm.Policy' resource was patched as requested. The 'kvm.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/kvm.Policy' links: GetKvmPolicyByMoid: operationId: GetKvmPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'kvm.Policy' resource is asynchronously being patched 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/kvm.Policy' links: GetKvmPolicyByMoid: operationId: GetKvmPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - kvm summary: Delete a 'kvm.Policy' resource. operationId: DeleteKvmPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.kvm.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/license/AccountLicenseData: get: tags: - license summary: Read a 'license.AccountLicenseData' resource. operationId: GetLicenseAccountLicenseDataList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Licensing Status - READ.license.AccountLicenseData - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/license.AccountLicenseData.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Read-Only - PRIVSET.View Licensing Status - READ.license.AccountLicenseData - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/license.AccountLicenseData' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.AccountLicenseData' resource is asynchronously being modified 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/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 - 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.AccountLicenseData' resource is asynchronously being patched 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/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.View Licensing Status - READ.license.CustomerOp - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/license.CustomerOp.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Licensing Status - READ.license.CustomerOp - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 - 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/license.CustomerOp' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.CustomerOp' resource is asynchronously being modified 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/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 - 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.CustomerOp' resource is asynchronously being patched 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/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/LicenseInfos: get: tags: - license summary: Read a 'license.LicenseInfo' resource. operationId: GetLicenseLicenseInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Licensing Status - READ.license.LicenseInfo - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/license.LicenseInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.LicenseInfo' 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/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 summary: Read a 'license.LicenseInfo' resource. operationId: GetLicenseLicenseInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Licensing Status - READ.license.LicenseInfo - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/license.LicenseInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.LicenseInfo' resource is asynchronously being modified 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/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.LicenseInfo' resource is asynchronously being patched 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/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/LicenseReservationOps: get: tags: - license summary: Read a 'license.LicenseReservationOp' resource. operationId: GetLicenseLicenseReservationOpList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Licensing Status - READ.license.LicenseReservationOp - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/license.LicenseReservationOp.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.LicenseReservationOp' 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/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.View Licensing Status - READ.license.LicenseReservationOp - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/license.LicenseReservationOp' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.LicenseReservationOp' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.LicenseReservationOp' resource is asynchronously being patched 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/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.View Licensing Status - READ.license.SmartlicenseToken - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/license.SmartlicenseToken.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Licensing Status - READ.license.SmartlicenseToken - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/license.SmartlicenseToken' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.SmartlicenseToken' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'license.SmartlicenseToken' resource is asynchronously being patched 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/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/ls/ServiceProfiles: get: tags: - ls summary: Read a 'ls.ServiceProfile' resource. operationId: GetLsServiceProfileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.ls.ServiceProfile - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'ls.ServiceProfile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ls.ServiceProfile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ls/ServiceProfiles/{Moid}: get: tags: - ls summary: Read a 'ls.ServiceProfile' resource. operationId: GetLsServiceProfileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.ls.ServiceProfile - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ls.ServiceProfile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ls.ServiceProfile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetLsServiceProfileByMoid: operationId: GetLsServiceProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ls summary: Update a 'ls.ServiceProfile' resource. operationId: UpdateLsServiceProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.ls.ServiceProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ls.ServiceProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ls.ServiceProfile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ls.ServiceProfile' resource was modified as requested. The 'ls.ServiceProfile' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ls.ServiceProfile' links: GetLsServiceProfileByMoid: operationId: GetLsServiceProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ls.ServiceProfile' resource is asynchronously being modified 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/ls.ServiceProfile' links: GetLsServiceProfileByMoid: operationId: GetLsServiceProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ls summary: Update a 'ls.ServiceProfile' resource. operationId: PatchLsServiceProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.ls.ServiceProfile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ls.ServiceProfile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ls.ServiceProfile' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ls.ServiceProfile' resource was patched as requested. The 'ls.ServiceProfile' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ls.ServiceProfile' links: GetLsServiceProfileByMoid: operationId: GetLsServiceProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ls.ServiceProfile' resource is asynchronously being patched 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/ls.ServiceProfile' links: GetLsServiceProfileByMoid: operationId: GetLsServiceProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/IdBlocks: get: tags: - macpool summary: Read a 'macpool.IdBlock' resource. operationId: GetMacpoolIdBlockList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.IdBlock - 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 'macpool.IdBlock' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/macpool.IdBlock.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/IdBlocks/{Moid}: get: tags: - macpool summary: Read a 'macpool.IdBlock' resource. operationId: GetMacpoolIdBlockByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.IdBlock - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'macpool.IdBlock' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/macpool.IdBlock' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMacpoolIdBlockByMoid: operationId: GetMacpoolIdBlockByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/IdBlocks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/Leases: get: tags: - macpool summary: Read a 'macpool.Lease' resource. operationId: GetMacpoolLeaseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.Lease - 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 'macpool.Lease' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/macpool.Lease.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/Leases/{Moid}: get: tags: - macpool summary: Read a 'macpool.Lease' resource. operationId: GetMacpoolLeaseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.Lease - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'macpool.Lease' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/macpool.Lease' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMacpoolLeaseByMoid: operationId: GetMacpoolLeaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Leases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/Pools: get: tags: - macpool summary: Read a 'macpool.Pool' resource. operationId: GetMacpoolPoolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.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 'macpool.Pool' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/macpool.Pool.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - macpool summary: Create a 'macpool.Pool' resource. operationId: CreateMacpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.macpool.Pool - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'macpool.Pool' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/macpool.Pool' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Pool' resource was created as requested. The 'macpool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/macpool.Pool' links: GetMacpoolPoolByMoid: operationId: GetMacpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'macpool.Pool' 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/macpool.Pool' links: GetMacpoolPoolByMoid: operationId: GetMacpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/Pools/{Moid}: get: tags: - macpool summary: Read a 'macpool.Pool' resource. operationId: GetMacpoolPoolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.Pool - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'macpool.Pool' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/macpool.Pool' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMacpoolPoolByMoid: operationId: GetMacpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - macpool summary: Update a 'macpool.Pool' resource. operationId: UpdateMacpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.macpool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'macpool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/macpool.Pool' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Pool' resource was modified as requested. The 'macpool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/macpool.Pool' links: GetMacpoolPoolByMoid: operationId: GetMacpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'macpool.Pool' resource is asynchronously being modified 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/macpool.Pool' links: GetMacpoolPoolByMoid: operationId: GetMacpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - macpool summary: Update a 'macpool.Pool' resource. operationId: PatchMacpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.macpool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'macpool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/macpool.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 'macpool.Pool' resource was patched as requested. The 'macpool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/macpool.Pool' links: GetMacpoolPoolByMoid: operationId: GetMacpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'macpool.Pool' resource is asynchronously being patched 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/macpool.Pool' links: GetMacpoolPoolByMoid: operationId: GetMacpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - macpool summary: Delete a 'macpool.Pool' resource. operationId: DeleteMacpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.macpool.Pool - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/PoolMembers: get: tags: - macpool summary: Read a 'macpool.PoolMember' resource. operationId: GetMacpoolPoolMemberList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.PoolMember - 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 'macpool.PoolMember' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/macpool.PoolMember.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/PoolMembers/{Moid}: get: tags: - macpool summary: Read a 'macpool.PoolMember' resource. operationId: GetMacpoolPoolMemberByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.PoolMember - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'macpool.PoolMember' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/macpool.PoolMember' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMacpoolPoolMemberByMoid: operationId: GetMacpoolPoolMemberByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/PoolMembers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/Universes: get: tags: - macpool summary: Read a 'macpool.Universe' resource. operationId: GetMacpoolUniverseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.Universe - 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 'macpool.Universe' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/macpool.Universe.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/macpool/Universes/{Moid}: get: tags: - macpool summary: Read a 'macpool.Universe' resource. operationId: GetMacpoolUniverseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.macpool.Universe - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'macpool.Universe' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/macpool.Universe' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMacpoolUniverseByMoid: operationId: GetMacpoolUniverseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Universes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/management/Controllers: get: tags: - management summary: Read a 'management.Controller' resource. operationId: GetManagementControllerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.management.Controller - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'management.Controller' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/management.Controller.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/management/Controllers/{Moid}: get: tags: - management summary: Read a 'management.Controller' resource. operationId: GetManagementControllerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.management.Controller - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'management.Controller' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/management.Controller' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetManagementControllerByMoid: operationId: GetManagementControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - management summary: Update a 'management.Controller' resource. operationId: UpdateManagementController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.management.Controller parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'management.Controller' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/management.Controller' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'management.Controller' resource was modified as requested. The 'management.Controller' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/management.Controller' links: GetManagementControllerByMoid: operationId: GetManagementControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'management.Controller' resource is asynchronously being modified 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/management.Controller' links: GetManagementControllerByMoid: operationId: GetManagementControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - management summary: Update a 'management.Controller' resource. operationId: PatchManagementController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.management.Controller parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'management.Controller' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/management.Controller' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'management.Controller' resource was patched as requested. The 'management.Controller' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/management.Controller' links: GetManagementControllerByMoid: operationId: GetManagementControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'management.Controller' resource is asynchronously being patched 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/management.Controller' links: GetManagementControllerByMoid: operationId: GetManagementControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/management/Entities: get: tags: - management summary: Read a 'management.Entity' resource. operationId: GetManagementEntityList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.management.Entity - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'management.Entity' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/management.Entity.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/management/Entities/{Moid}: get: tags: - management summary: Read a 'management.Entity' resource. operationId: GetManagementEntityByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.management.Entity - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'management.Entity' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/management.Entity' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetManagementEntityByMoid: operationId: GetManagementEntityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - management summary: Update a 'management.Entity' resource. operationId: UpdateManagementEntity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.management.Entity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'management.Entity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/management.Entity' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'management.Entity' resource was modified as requested. The 'management.Entity' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/management.Entity' links: GetManagementEntityByMoid: operationId: GetManagementEntityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'management.Entity' resource is asynchronously being modified 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/management.Entity' links: GetManagementEntityByMoid: operationId: GetManagementEntityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - management summary: Update a 'management.Entity' resource. operationId: PatchManagementEntity security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.management.Entity parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'management.Entity' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/management.Entity' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'management.Entity' resource was patched as requested. The 'management.Entity' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/management.Entity' links: GetManagementEntityByMoid: operationId: GetManagementEntityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'management.Entity' resource is asynchronously being patched 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/management.Entity' links: GetManagementEntityByMoid: operationId: GetManagementEntityByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/management/Interfaces: get: tags: - management summary: Read a 'management.Interface' resource. operationId: GetManagementInterfaceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.management.Interface - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'management.Interface' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/management.Interface.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/management/Interfaces/{Moid}: get: tags: - management summary: Read a 'management.Interface' resource. operationId: GetManagementInterfaceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.management.Interface - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'management.Interface' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/management.Interface' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetManagementInterfaceByMoid: operationId: GetManagementInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - management summary: Update a 'management.Interface' resource. operationId: UpdateManagementInterface security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.management.Interface parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'management.Interface' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/management.Interface' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'management.Interface' resource was modified as requested. The 'management.Interface' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/management.Interface' links: GetManagementInterfaceByMoid: operationId: GetManagementInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'management.Interface' resource is asynchronously being modified 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/management.Interface' links: GetManagementInterfaceByMoid: operationId: GetManagementInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - management summary: Update a 'management.Interface' resource. operationId: PatchManagementInterface security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.management.Interface parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'management.Interface' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/management.Interface' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'management.Interface' resource was patched as requested. The 'management.Interface' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/management.Interface' links: GetManagementInterfaceByMoid: operationId: GetManagementInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'management.Interface' resource is asynchronously being patched 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/management.Interface' links: GetManagementInterfaceByMoid: operationId: GetManagementInterfaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/Arrays: get: tags: - memory summary: Read a 'memory.Array' resource. operationId: GetMemoryArrayList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.Array - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.Array' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.Array.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/Arrays/{Moid}: get: tags: - memory summary: Read a 'memory.Array' resource. operationId: GetMemoryArrayByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.Array - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.Array' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.Array' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryArrayByMoid: operationId: GetMemoryArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.Array' resource. operationId: UpdateMemoryArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.Array parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.Array' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.Array' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Array' resource was modified as requested. The 'memory.Array' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.Array' links: GetMemoryArrayByMoid: operationId: GetMemoryArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.Array' resource is asynchronously being modified 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/memory.Array' links: GetMemoryArrayByMoid: operationId: GetMemoryArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.Array' resource. operationId: PatchMemoryArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.Array parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.Array' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.Array' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Array' resource was patched as requested. The 'memory.Array' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.Array' links: GetMemoryArrayByMoid: operationId: GetMemoryArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.Array' resource is asynchronously being patched 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/memory.Array' links: GetMemoryArrayByMoid: operationId: GetMemoryArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryConfigResults: get: tags: - memory summary: Read a 'memory.PersistentMemoryConfigResult' resource. operationId: GetMemoryPersistentMemoryConfigResultList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryConfigResult - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.PersistentMemoryConfigResult' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.PersistentMemoryConfigResult.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryConfigResults/{Moid}: get: tags: - memory summary: Read a 'memory.PersistentMemoryConfigResult' resource. operationId: GetMemoryPersistentMemoryConfigResultByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryConfigResult - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.PersistentMemoryConfigResult' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfigResult' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryPersistentMemoryConfigResultByMoid: operationId: GetMemoryPersistentMemoryConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.PersistentMemoryConfigResult' resource. operationId: UpdateMemoryPersistentMemoryConfigResult security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryConfigResult parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryConfigResult' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfigResult' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfigResult' resource was modified as requested. The 'memory.PersistentMemoryConfigResult' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfigResult' links: GetMemoryPersistentMemoryConfigResultByMoid: operationId: GetMemoryPersistentMemoryConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryConfigResult' resource is asynchronously being modified 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/memory.PersistentMemoryConfigResult' links: GetMemoryPersistentMemoryConfigResultByMoid: operationId: GetMemoryPersistentMemoryConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.PersistentMemoryConfigResult' resource. operationId: PatchMemoryPersistentMemoryConfigResult security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryConfigResult parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryConfigResult' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfigResult' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfigResult' resource was patched as requested. The 'memory.PersistentMemoryConfigResult' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfigResult' links: GetMemoryPersistentMemoryConfigResultByMoid: operationId: GetMemoryPersistentMemoryConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryConfigResult' resource is asynchronously being patched 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/memory.PersistentMemoryConfigResult' links: GetMemoryPersistentMemoryConfigResultByMoid: operationId: GetMemoryPersistentMemoryConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryConfigurations: get: tags: - memory summary: Read a 'memory.PersistentMemoryConfiguration' resource. operationId: GetMemoryPersistentMemoryConfigurationList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryConfiguration - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.PersistentMemoryConfiguration' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.PersistentMemoryConfiguration.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryConfigurations/{Moid}: get: tags: - memory summary: Read a 'memory.PersistentMemoryConfiguration' resource. operationId: GetMemoryPersistentMemoryConfigurationByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryConfiguration - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.PersistentMemoryConfiguration' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfiguration' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryPersistentMemoryConfigurationByMoid: operationId: GetMemoryPersistentMemoryConfigurationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.PersistentMemoryConfiguration' resource. operationId: UpdateMemoryPersistentMemoryConfiguration security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryConfiguration parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryConfiguration' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfiguration' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfiguration' resource was modified as requested. The 'memory.PersistentMemoryConfiguration' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfiguration' links: GetMemoryPersistentMemoryConfigurationByMoid: operationId: GetMemoryPersistentMemoryConfigurationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryConfiguration' resource is asynchronously being modified 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/memory.PersistentMemoryConfiguration' links: GetMemoryPersistentMemoryConfigurationByMoid: operationId: GetMemoryPersistentMemoryConfigurationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.PersistentMemoryConfiguration' resource. operationId: PatchMemoryPersistentMemoryConfiguration security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryConfiguration parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryConfiguration' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfiguration' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfiguration' resource was patched as requested. The 'memory.PersistentMemoryConfiguration' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryConfiguration' links: GetMemoryPersistentMemoryConfigurationByMoid: operationId: GetMemoryPersistentMemoryConfigurationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryConfiguration' resource is asynchronously being patched 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/memory.PersistentMemoryConfiguration' links: GetMemoryPersistentMemoryConfigurationByMoid: operationId: GetMemoryPersistentMemoryConfigurationByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryNamespaces: get: tags: - memory summary: Read a 'memory.PersistentMemoryNamespace' resource. operationId: GetMemoryPersistentMemoryNamespaceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryNamespace - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.PersistentMemoryNamespace' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespace.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryNamespaces/{Moid}: get: tags: - memory summary: Read a 'memory.PersistentMemoryNamespace' resource. operationId: GetMemoryPersistentMemoryNamespaceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryNamespace - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.PersistentMemoryNamespace' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespace' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryPersistentMemoryNamespaceByMoid: operationId: GetMemoryPersistentMemoryNamespaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.PersistentMemoryNamespace' resource. operationId: UpdateMemoryPersistentMemoryNamespace security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryNamespace parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryNamespace' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespace' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespace' resource was modified as requested. The 'memory.PersistentMemoryNamespace' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespace' links: GetMemoryPersistentMemoryNamespaceByMoid: operationId: GetMemoryPersistentMemoryNamespaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryNamespace' resource is asynchronously being modified 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/memory.PersistentMemoryNamespace' links: GetMemoryPersistentMemoryNamespaceByMoid: operationId: GetMemoryPersistentMemoryNamespaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.PersistentMemoryNamespace' resource. operationId: PatchMemoryPersistentMemoryNamespace security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryNamespace parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryNamespace' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespace' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespace' resource was patched as requested. The 'memory.PersistentMemoryNamespace' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespace' links: GetMemoryPersistentMemoryNamespaceByMoid: operationId: GetMemoryPersistentMemoryNamespaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryNamespace' resource is asynchronously being patched 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/memory.PersistentMemoryNamespace' links: GetMemoryPersistentMemoryNamespaceByMoid: operationId: GetMemoryPersistentMemoryNamespaceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryNamespaceConfigResults: get: tags: - memory summary: Read a 'memory.PersistentMemoryNamespaceConfigResult' resource. operationId: GetMemoryPersistentMemoryNamespaceConfigResultList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryNamespaceConfigResult - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.PersistentMemoryNamespaceConfigResult' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}: get: tags: - memory summary: Read a 'memory.PersistentMemoryNamespaceConfigResult' resource. operationId: GetMemoryPersistentMemoryNamespaceConfigResultByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryNamespaceConfigResult - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.PersistentMemoryNamespaceConfigResult' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryPersistentMemoryNamespaceConfigResultByMoid: operationId: GetMemoryPersistentMemoryNamespaceConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.PersistentMemoryNamespaceConfigResult' resource. operationId: UpdateMemoryPersistentMemoryNamespaceConfigResult security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryNamespaceConfigResult parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryNamespaceConfigResult' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespaceConfigResult' resource was modified as requested. The 'memory.PersistentMemoryNamespaceConfigResult' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult' links: GetMemoryPersistentMemoryNamespaceConfigResultByMoid: operationId: GetMemoryPersistentMemoryNamespaceConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryNamespaceConfigResult' resource is asynchronously being modified 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/memory.PersistentMemoryNamespaceConfigResult' links: GetMemoryPersistentMemoryNamespaceConfigResultByMoid: operationId: GetMemoryPersistentMemoryNamespaceConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.PersistentMemoryNamespaceConfigResult' resource. operationId: PatchMemoryPersistentMemoryNamespaceConfigResult security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryNamespaceConfigResult parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryNamespaceConfigResult' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespaceConfigResult' resource was patched as requested. The 'memory.PersistentMemoryNamespaceConfigResult' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult' links: GetMemoryPersistentMemoryNamespaceConfigResultByMoid: operationId: GetMemoryPersistentMemoryNamespaceConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryNamespaceConfigResult' resource is asynchronously being patched 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/memory.PersistentMemoryNamespaceConfigResult' links: GetMemoryPersistentMemoryNamespaceConfigResultByMoid: operationId: GetMemoryPersistentMemoryNamespaceConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryPolicies: get: tags: - memory summary: Read a 'memory.PersistentMemoryPolicy' resource. operationId: GetMemoryPersistentMemoryPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.memory.PersistentMemoryPolicy - 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 'memory.PersistentMemoryPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Create a 'memory.PersistentMemoryPolicy' resource. operationId: CreateMemoryPersistentMemoryPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.memory.PersistentMemoryPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'memory.PersistentMemoryPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryPolicy' resource was created as requested. The 'memory.PersistentMemoryPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' links: GetMemoryPersistentMemoryPolicyByMoid: operationId: GetMemoryPersistentMemoryPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryPolicy' 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/memory.PersistentMemoryPolicy' links: GetMemoryPersistentMemoryPolicyByMoid: operationId: GetMemoryPersistentMemoryPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryPolicies/{Moid}: get: tags: - memory summary: Read a 'memory.PersistentMemoryPolicy' resource. operationId: GetMemoryPersistentMemoryPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.memory.PersistentMemoryPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.PersistentMemoryPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryPersistentMemoryPolicyByMoid: operationId: GetMemoryPersistentMemoryPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.PersistentMemoryPolicy' resource. operationId: UpdateMemoryPersistentMemoryPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryPolicy' resource was modified as requested. The 'memory.PersistentMemoryPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' links: GetMemoryPersistentMemoryPolicyByMoid: operationId: GetMemoryPersistentMemoryPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryPolicy' resource is asynchronously being modified 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/memory.PersistentMemoryPolicy' links: GetMemoryPersistentMemoryPolicyByMoid: operationId: GetMemoryPersistentMemoryPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.PersistentMemoryPolicy' resource. operationId: PatchMemoryPersistentMemoryPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryPolicy' resource was patched as requested. The 'memory.PersistentMemoryPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' links: GetMemoryPersistentMemoryPolicyByMoid: operationId: GetMemoryPersistentMemoryPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryPolicy' resource is asynchronously being patched 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/memory.PersistentMemoryPolicy' links: GetMemoryPersistentMemoryPolicyByMoid: operationId: GetMemoryPersistentMemoryPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - memory summary: Delete a 'memory.PersistentMemoryPolicy' resource. operationId: DeleteMemoryPersistentMemoryPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.memory.PersistentMemoryPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryRegions: get: tags: - memory summary: Read a 'memory.PersistentMemoryRegion' resource. operationId: GetMemoryPersistentMemoryRegionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryRegion - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.PersistentMemoryRegion' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.PersistentMemoryRegion.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryRegions/{Moid}: get: tags: - memory summary: Read a 'memory.PersistentMemoryRegion' resource. operationId: GetMemoryPersistentMemoryRegionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryRegion - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.PersistentMemoryRegion' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryRegion' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryPersistentMemoryRegionByMoid: operationId: GetMemoryPersistentMemoryRegionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.PersistentMemoryRegion' resource. operationId: UpdateMemoryPersistentMemoryRegion security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryRegion parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryRegion' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryRegion' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryRegion' resource was modified as requested. The 'memory.PersistentMemoryRegion' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryRegion' links: GetMemoryPersistentMemoryRegionByMoid: operationId: GetMemoryPersistentMemoryRegionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryRegion' resource is asynchronously being modified 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/memory.PersistentMemoryRegion' links: GetMemoryPersistentMemoryRegionByMoid: operationId: GetMemoryPersistentMemoryRegionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.PersistentMemoryRegion' resource. operationId: PatchMemoryPersistentMemoryRegion security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryRegion parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryRegion' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryRegion' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryRegion' resource was patched as requested. The 'memory.PersistentMemoryRegion' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryRegion' links: GetMemoryPersistentMemoryRegionByMoid: operationId: GetMemoryPersistentMemoryRegionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryRegion' resource is asynchronously being patched 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/memory.PersistentMemoryRegion' links: GetMemoryPersistentMemoryRegionByMoid: operationId: GetMemoryPersistentMemoryRegionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryUnits: get: tags: - memory summary: Read a 'memory.PersistentMemoryUnit' resource. operationId: GetMemoryPersistentMemoryUnitList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryUnit - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.PersistentMemoryUnit' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.PersistentMemoryUnit.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/PersistentMemoryUnits/{Moid}: get: tags: - memory summary: Read a 'memory.PersistentMemoryUnit' resource. operationId: GetMemoryPersistentMemoryUnitByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.PersistentMemoryUnit - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.PersistentMemoryUnit' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryUnit' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryPersistentMemoryUnitByMoid: operationId: GetMemoryPersistentMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.PersistentMemoryUnit' resource. operationId: UpdateMemoryPersistentMemoryUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryUnit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryUnit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryUnit' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryUnit' resource was modified as requested. The 'memory.PersistentMemoryUnit' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryUnit' links: GetMemoryPersistentMemoryUnitByMoid: operationId: GetMemoryPersistentMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryUnit' resource is asynchronously being modified 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/memory.PersistentMemoryUnit' links: GetMemoryPersistentMemoryUnitByMoid: operationId: GetMemoryPersistentMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.PersistentMemoryUnit' resource. operationId: PatchMemoryPersistentMemoryUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.PersistentMemoryUnit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.PersistentMemoryUnit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryUnit' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryUnit' resource was patched as requested. The 'memory.PersistentMemoryUnit' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.PersistentMemoryUnit' links: GetMemoryPersistentMemoryUnitByMoid: operationId: GetMemoryPersistentMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.PersistentMemoryUnit' resource is asynchronously being patched 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/memory.PersistentMemoryUnit' links: GetMemoryPersistentMemoryUnitByMoid: operationId: GetMemoryPersistentMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/Units: get: tags: - memory summary: Read a 'memory.Unit' resource. operationId: GetMemoryUnitList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'memory.Unit' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/memory.Unit.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/memory/Units/{Moid}: get: tags: - memory summary: Read a 'memory.Unit' resource. operationId: GetMemoryUnitByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.memory.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'memory.Unit' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/memory.Unit' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetMemoryUnitByMoid: operationId: GetMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - memory summary: Update a 'memory.Unit' resource. operationId: UpdateMemoryUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.Unit' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Unit' resource was modified as requested. The 'memory.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.Unit' links: GetMemoryUnitByMoid: operationId: GetMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.Unit' resource is asynchronously being modified 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/memory.Unit' links: GetMemoryUnitByMoid: operationId: GetMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - memory summary: Update a 'memory.Unit' resource. operationId: PatchMemoryUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.memory.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'memory.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/memory.Unit' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Unit' resource was patched as requested. The 'memory.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/memory.Unit' links: GetMemoryUnitByMoid: operationId: GetMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'memory.Unit' resource is asynchronously being patched 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/memory.Unit' links: GetMemoryUnitByMoid: operationId: GetMemoryUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/meta/Definitions: get: tags: - meta summary: Read a 'meta.Definition' resource. operationId: GetMetaDefinitionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/meta.Definition.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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}: delete: tags: - meta summary: Delete a 'meta.Definition' resource. operationId: DeleteMetaDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.meta.Definition 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - meta summary: Read a 'meta.Definition' resource. operationId: GetMetaDefinitionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.meta.Definition parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/network/Elements: get: tags: - network summary: Read a 'network.Element' resource. operationId: GetNetworkElementList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.Element - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'network.Element' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/network.Element.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/network/Elements/{Moid}: get: tags: - network summary: Read a 'network.Element' resource. operationId: GetNetworkElementByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.Element - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'network.Element' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/network.Element' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNetworkElementByMoid: operationId: GetNetworkElementByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/Elements/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - network summary: Update a 'network.Element' resource. operationId: UpdateNetworkElement security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.network.Element parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'network.Element' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/network.Element' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'network.Element' resource was modified as requested. The 'network.Element' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/network.Element' links: GetNetworkElementByMoid: operationId: GetNetworkElementByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/Elements/{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 'network.Element' resource is asynchronously being modified 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/network.Element' links: GetNetworkElementByMoid: operationId: GetNetworkElementByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/Elements/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - network summary: Update a 'network.Element' resource. operationId: PatchNetworkElement security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.network.Element parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'network.Element' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/network.Element' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'network.Element' resource was patched as requested. The 'network.Element' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/network.Element' links: GetNetworkElementByMoid: operationId: GetNetworkElementByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/Elements/{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 'network.Element' resource is asynchronously being patched 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/network.Element' links: GetNetworkElementByMoid: operationId: GetNetworkElementByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/Elements/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/network/ElementSummaries: get: tags: - network summary: Read a 'network.ElementSummary' resource. operationId: GetNetworkElementSummaryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.ElementSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'network.ElementSummary' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/network.ElementSummary.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/network/ElementSummaries/{Moid}: get: tags: - network summary: Read a 'network.ElementSummary' resource. operationId: GetNetworkElementSummaryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.ElementSummary - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'network.ElementSummary' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/network.ElementSummary' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNetworkElementSummaryByMoid: operationId: GetNetworkElementSummaryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/ElementSummaries/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/network/FcZoneInfos: get: tags: - network summary: Read a 'network.FcZoneInfo' resource. operationId: GetNetworkFcZoneInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.FcZoneInfo - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'network.FcZoneInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/network.FcZoneInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/network/FcZoneInfos/{Moid}: get: tags: - network summary: Read a 'network.FcZoneInfo' resource. operationId: GetNetworkFcZoneInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.FcZoneInfo - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'network.FcZoneInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/network.FcZoneInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNetworkFcZoneInfoByMoid: operationId: GetNetworkFcZoneInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/FcZoneInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - network summary: Update a 'network.FcZoneInfo' resource. operationId: UpdateNetworkFcZoneInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.network.FcZoneInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'network.FcZoneInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/network.FcZoneInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'network.FcZoneInfo' resource was modified as requested. The 'network.FcZoneInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/network.FcZoneInfo' links: GetNetworkFcZoneInfoByMoid: operationId: GetNetworkFcZoneInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/FcZoneInfos/{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 'network.FcZoneInfo' resource is asynchronously being modified 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/network.FcZoneInfo' links: GetNetworkFcZoneInfoByMoid: operationId: GetNetworkFcZoneInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/FcZoneInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - network summary: Update a 'network.FcZoneInfo' resource. operationId: PatchNetworkFcZoneInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.network.FcZoneInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'network.FcZoneInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/network.FcZoneInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'network.FcZoneInfo' resource was patched as requested. The 'network.FcZoneInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/network.FcZoneInfo' links: GetNetworkFcZoneInfoByMoid: operationId: GetNetworkFcZoneInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/FcZoneInfos/{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 'network.FcZoneInfo' resource is asynchronously being patched 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/network.FcZoneInfo' links: GetNetworkFcZoneInfoByMoid: operationId: GetNetworkFcZoneInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/FcZoneInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/network/VlanPortInfos: get: tags: - network summary: Read a 'network.VlanPortInfo' resource. operationId: GetNetworkVlanPortInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.VlanPortInfo - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'network.VlanPortInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/network.VlanPortInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/network/VlanPortInfos/{Moid}: get: tags: - network summary: Read a 'network.VlanPortInfo' resource. operationId: GetNetworkVlanPortInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.network.VlanPortInfo - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'network.VlanPortInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/network.VlanPortInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNetworkVlanPortInfoByMoid: operationId: GetNetworkVlanPortInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/VlanPortInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - network summary: Update a 'network.VlanPortInfo' resource. operationId: UpdateNetworkVlanPortInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.network.VlanPortInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'network.VlanPortInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/network.VlanPortInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'network.VlanPortInfo' resource was modified as requested. The 'network.VlanPortInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/network.VlanPortInfo' links: GetNetworkVlanPortInfoByMoid: operationId: GetNetworkVlanPortInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/VlanPortInfos/{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 'network.VlanPortInfo' resource is asynchronously being modified 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/network.VlanPortInfo' links: GetNetworkVlanPortInfoByMoid: operationId: GetNetworkVlanPortInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/VlanPortInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - network summary: Update a 'network.VlanPortInfo' resource. operationId: PatchNetworkVlanPortInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.network.VlanPortInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'network.VlanPortInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/network.VlanPortInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'network.VlanPortInfo' resource was patched as requested. The 'network.VlanPortInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/network.VlanPortInfo' links: GetNetworkVlanPortInfoByMoid: operationId: GetNetworkVlanPortInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/VlanPortInfos/{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 'network.VlanPortInfo' resource is asynchronously being patched 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/network.VlanPortInfo' links: GetNetworkVlanPortInfoByMoid: operationId: GetNetworkVlanPortInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/network/VlanPortInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/networkconfig/Policies: post: tags: - networkconfig summary: Create a 'networkconfig.Policy' resource. operationId: CreateNetworkconfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.networkconfig.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'networkconfig.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/networkconfig.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'networkconfig.Policy' resource was created as requested. The 'networkconfig.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/networkconfig.Policy' links: GetNetworkconfigPolicyByMoid: operationId: GetNetworkconfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'networkconfig.Policy' 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/networkconfig.Policy' links: GetNetworkconfigPolicyByMoid: operationId: GetNetworkconfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - networkconfig summary: Read a 'networkconfig.Policy' resource. operationId: GetNetworkconfigPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.networkconfig.Policy - 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 'networkconfig.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/networkconfig.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/networkconfig/Policies/{Moid}: get: tags: - networkconfig summary: Read a 'networkconfig.Policy' resource. operationId: GetNetworkconfigPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.networkconfig.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'networkconfig.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/networkconfig.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNetworkconfigPolicyByMoid: operationId: GetNetworkconfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - networkconfig summary: Update a 'networkconfig.Policy' resource. operationId: UpdateNetworkconfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.networkconfig.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'networkconfig.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/networkconfig.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'networkconfig.Policy' resource was modified as requested. The 'networkconfig.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/networkconfig.Policy' links: GetNetworkconfigPolicyByMoid: operationId: GetNetworkconfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'networkconfig.Policy' resource is asynchronously being modified 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/networkconfig.Policy' links: GetNetworkconfigPolicyByMoid: operationId: GetNetworkconfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - networkconfig summary: Update a 'networkconfig.Policy' resource. operationId: PatchNetworkconfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.networkconfig.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'networkconfig.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/networkconfig.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 'networkconfig.Policy' resource was patched as requested. The 'networkconfig.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/networkconfig.Policy' links: GetNetworkconfigPolicyByMoid: operationId: GetNetworkconfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'networkconfig.Policy' resource is asynchronously being patched 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/networkconfig.Policy' links: GetNetworkconfigPolicyByMoid: operationId: GetNetworkconfigPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - networkconfig summary: Delete a 'networkconfig.Policy' resource. operationId: DeleteNetworkconfigPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.networkconfig.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/niaapi/ApicCcoPosts: get: tags: - niaapi summary: Read a 'niaapi.ApicCcoPost' resource. operationId: GetNiaapiApicCcoPostList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicCcoPost - 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 'niaapi.ApicCcoPost' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.ApicCcoPost.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicCcoPosts/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.ApicCcoPost' resource. operationId: GetNiaapiApicCcoPostByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicCcoPost - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.ApicCcoPost' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.ApicCcoPost' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiApicCcoPostByMoid: operationId: GetNiaapiApicCcoPostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/ApicCcoPosts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicFieldNotices: get: tags: - niaapi summary: Read a 'niaapi.ApicFieldNotice' resource. operationId: GetNiaapiApicFieldNoticeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicFieldNotice - 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 'niaapi.ApicFieldNotice' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.ApicFieldNotice.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicFieldNotices/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.ApicFieldNotice' resource. operationId: GetNiaapiApicFieldNoticeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicFieldNotice - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.ApicFieldNotice' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.ApicFieldNotice' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiApicFieldNoticeByMoid: operationId: GetNiaapiApicFieldNoticeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/ApicFieldNotices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicHweols: get: tags: - niaapi summary: Read a 'niaapi.ApicHweol' resource. operationId: GetNiaapiApicHweolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicHweol - 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 'niaapi.ApicHweol' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.ApicHweol.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicHweols/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.ApicHweol' resource. operationId: GetNiaapiApicHweolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicHweol - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.ApicHweol' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.ApicHweol' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiApicHweolByMoid: operationId: GetNiaapiApicHweolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/ApicHweols/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicLatestMaintainedReleases: get: tags: - niaapi summary: Read a 'niaapi.ApicLatestMaintainedRelease' resource. operationId: GetNiaapiApicLatestMaintainedReleaseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicLatestMaintainedRelease - 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 'niaapi.ApicLatestMaintainedRelease' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.ApicLatestMaintainedRelease.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicLatestMaintainedReleases/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.ApicLatestMaintainedRelease' resource. operationId: GetNiaapiApicLatestMaintainedReleaseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicLatestMaintainedRelease - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.ApicLatestMaintainedRelease' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.ApicLatestMaintainedRelease' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiApicLatestMaintainedReleaseByMoid: operationId: GetNiaapiApicLatestMaintainedReleaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/ApicLatestMaintainedReleases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicReleaseRecommends: get: tags: - niaapi summary: Read a 'niaapi.ApicReleaseRecommend' resource. operationId: GetNiaapiApicReleaseRecommendList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicReleaseRecommend - 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 'niaapi.ApicReleaseRecommend' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.ApicReleaseRecommend.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicReleaseRecommends/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.ApicReleaseRecommend' resource. operationId: GetNiaapiApicReleaseRecommendByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicReleaseRecommend - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.ApicReleaseRecommend' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.ApicReleaseRecommend' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiApicReleaseRecommendByMoid: operationId: GetNiaapiApicReleaseRecommendByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/ApicReleaseRecommends/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicSweols: get: tags: - niaapi summary: Read a 'niaapi.ApicSweol' resource. operationId: GetNiaapiApicSweolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicSweol - 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 'niaapi.ApicSweol' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.ApicSweol.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/ApicSweols/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.ApicSweol' resource. operationId: GetNiaapiApicSweolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.ApicSweol - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.ApicSweol' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.ApicSweol' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiApicSweolByMoid: operationId: GetNiaapiApicSweolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/ApicSweols/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmCcoPosts: get: tags: - niaapi summary: Read a 'niaapi.DcnmCcoPost' resource. operationId: GetNiaapiDcnmCcoPostList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmCcoPost - 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 'niaapi.DcnmCcoPost' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.DcnmCcoPost.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmCcoPosts/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.DcnmCcoPost' resource. operationId: GetNiaapiDcnmCcoPostByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmCcoPost - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.DcnmCcoPost' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.DcnmCcoPost' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiDcnmCcoPostByMoid: operationId: GetNiaapiDcnmCcoPostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/DcnmCcoPosts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmFieldNotices: get: tags: - niaapi summary: Read a 'niaapi.DcnmFieldNotice' resource. operationId: GetNiaapiDcnmFieldNoticeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmFieldNotice - 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 'niaapi.DcnmFieldNotice' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.DcnmFieldNotice.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmFieldNotices/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.DcnmFieldNotice' resource. operationId: GetNiaapiDcnmFieldNoticeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmFieldNotice - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.DcnmFieldNotice' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.DcnmFieldNotice' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiDcnmFieldNoticeByMoid: operationId: GetNiaapiDcnmFieldNoticeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/DcnmFieldNotices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmHweols: get: tags: - niaapi summary: Read a 'niaapi.DcnmHweol' resource. operationId: GetNiaapiDcnmHweolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmHweol - 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 'niaapi.DcnmHweol' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.DcnmHweol.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmHweols/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.DcnmHweol' resource. operationId: GetNiaapiDcnmHweolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmHweol - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.DcnmHweol' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.DcnmHweol' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiDcnmHweolByMoid: operationId: GetNiaapiDcnmHweolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/DcnmHweols/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmLatestMaintainedReleases: get: tags: - niaapi summary: Read a 'niaapi.DcnmLatestMaintainedRelease' resource. operationId: GetNiaapiDcnmLatestMaintainedReleaseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmLatestMaintainedRelease - 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 'niaapi.DcnmLatestMaintainedRelease' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.DcnmLatestMaintainedRelease.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmLatestMaintainedReleases/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.DcnmLatestMaintainedRelease' resource. operationId: GetNiaapiDcnmLatestMaintainedReleaseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmLatestMaintainedRelease - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.DcnmLatestMaintainedRelease' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.DcnmLatestMaintainedRelease' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiDcnmLatestMaintainedReleaseByMoid: operationId: GetNiaapiDcnmLatestMaintainedReleaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/DcnmLatestMaintainedReleases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmReleaseRecommends: get: tags: - niaapi summary: Read a 'niaapi.DcnmReleaseRecommend' resource. operationId: GetNiaapiDcnmReleaseRecommendList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmReleaseRecommend - 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 'niaapi.DcnmReleaseRecommend' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.DcnmReleaseRecommend.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmReleaseRecommends/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.DcnmReleaseRecommend' resource. operationId: GetNiaapiDcnmReleaseRecommendByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmReleaseRecommend - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.DcnmReleaseRecommend' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.DcnmReleaseRecommend' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiDcnmReleaseRecommendByMoid: operationId: GetNiaapiDcnmReleaseRecommendByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/DcnmReleaseRecommends/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmSweols: get: tags: - niaapi summary: Read a 'niaapi.DcnmSweol' resource. operationId: GetNiaapiDcnmSweolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmSweol - 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 'niaapi.DcnmSweol' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.DcnmSweol.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/DcnmSweols/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.DcnmSweol' resource. operationId: GetNiaapiDcnmSweolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.DcnmSweol - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.DcnmSweol' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.DcnmSweol' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiDcnmSweolByMoid: operationId: GetNiaapiDcnmSweolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/DcnmSweols/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/FileDownloaders: get: tags: - niaapi summary: Read a 'niaapi.FileDownloader' resource. operationId: GetNiaapiFileDownloaderList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.FileDownloader - 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 'niaapi.FileDownloader' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.FileDownloader.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/FileDownloaders/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.FileDownloader' resource. operationId: GetNiaapiFileDownloaderByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.FileDownloader - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.FileDownloader' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.FileDownloader' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiFileDownloaderByMoid: operationId: GetNiaapiFileDownloaderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/FileDownloaders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/NiaMetadata: get: tags: - niaapi summary: Read a 'niaapi.NiaMetadata' resource. operationId: GetNiaapiNiaMetadataList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.NiaMetadata - 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 'niaapi.NiaMetadata' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.NiaMetadata.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/NiaMetadata/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.NiaMetadata' resource. operationId: GetNiaapiNiaMetadataByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.NiaMetadata - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.NiaMetadata' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.NiaMetadata' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiNiaMetadataByMoid: operationId: GetNiaapiNiaMetadataByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/NiaMetadata/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/VersionRegexes: get: tags: - niaapi summary: Read a 'niaapi.VersionRegex' resource. operationId: GetNiaapiVersionRegexList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.VersionRegex - 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 'niaapi.VersionRegex' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niaapi.VersionRegex.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niaapi/VersionRegexes/{Moid}: get: tags: - niaapi summary: Read a 'niaapi.VersionRegex' resource. operationId: GetNiaapiVersionRegexByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - READ.niaapi.VersionRegex - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niaapi.VersionRegex' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niaapi.VersionRegex' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiaapiVersionRegexByMoid: operationId: GetNiaapiVersionRegexByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niaapi/VersionRegexes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/Epgs: get: tags: - niatelemetry summary: Read a 'niatelemetry.Epg' resource. operationId: GetNiatelemetryEpgList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.Epg parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'niatelemetry.Epg' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niatelemetry.Epg.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/Epgs/{Moid}: get: tags: - niatelemetry summary: Read a 'niatelemetry.Epg' resource. operationId: GetNiatelemetryEpgByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.Epg parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niatelemetry.Epg' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niatelemetry.Epg' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiatelemetryEpgByMoid: operationId: GetNiatelemetryEpgByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niatelemetry/Epgs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/NiaFeatureUsages: get: tags: - niatelemetry summary: Read a 'niatelemetry.NiaFeatureUsage' resource. operationId: GetNiatelemetryNiaFeatureUsageList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.NiaFeatureUsage parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'niatelemetry.NiaFeatureUsage' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niatelemetry.NiaFeatureUsage.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/NiaFeatureUsages/{Moid}: get: tags: - niatelemetry summary: Read a 'niatelemetry.NiaFeatureUsage' resource. operationId: GetNiatelemetryNiaFeatureUsageByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.NiaFeatureUsage parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niatelemetry.NiaFeatureUsage' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niatelemetry.NiaFeatureUsage' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiatelemetryNiaFeatureUsageByMoid: operationId: GetNiatelemetryNiaFeatureUsageByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niatelemetry/NiaFeatureUsages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/NiaInventories: get: tags: - niatelemetry summary: Read a 'niatelemetry.NiaInventory' resource. operationId: GetNiatelemetryNiaInventoryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.NiaInventory parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'niatelemetry.NiaInventory' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niatelemetry.NiaInventory.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/NiaInventories/{Moid}: get: tags: - niatelemetry summary: Read a 'niatelemetry.NiaInventory' resource. operationId: GetNiatelemetryNiaInventoryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.NiaInventory parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niatelemetry.NiaInventory' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niatelemetry.NiaInventory' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiatelemetryNiaInventoryByMoid: operationId: GetNiatelemetryNiaInventoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niatelemetry/NiaInventories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/NiaLicenseStates: get: tags: - niatelemetry summary: Read a 'niatelemetry.NiaLicenseState' resource. operationId: GetNiatelemetryNiaLicenseStateList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.NiaLicenseState parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'niatelemetry.NiaLicenseState' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niatelemetry.NiaLicenseState.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/NiaLicenseStates/{Moid}: get: tags: - niatelemetry summary: Read a 'niatelemetry.NiaLicenseState' resource. operationId: GetNiatelemetryNiaLicenseStateByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.NiaLicenseState parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niatelemetry.NiaLicenseState' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niatelemetry.NiaLicenseState' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiatelemetryNiaLicenseStateByMoid: operationId: GetNiatelemetryNiaLicenseStateByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niatelemetry/NiaLicenseStates/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/Tenants: get: tags: - niatelemetry summary: Read a 'niatelemetry.Tenant' resource. operationId: GetNiatelemetryTenantList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.Tenant parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'niatelemetry.Tenant' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/niatelemetry.Tenant.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/niatelemetry/Tenants/{Moid}: get: tags: - niatelemetry summary: Read a 'niatelemetry.Tenant' resource. operationId: GetNiatelemetryTenantByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.niatelemetry.Tenant parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'niatelemetry.Tenant' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/niatelemetry.Tenant' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNiatelemetryTenantByMoid: operationId: GetNiatelemetryTenantByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/niatelemetry/Tenants/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ntp/Policies: post: tags: - ntp summary: Create a 'ntp.Policy' resource. operationId: CreateNtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.ntp.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'ntp.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/ntp.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ntp.Policy' resource was created as requested. The 'ntp.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ntp.Policy' links: GetNtpPolicyByMoid: operationId: GetNtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ntp.Policy' 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/ntp.Policy' links: GetNtpPolicyByMoid: operationId: GetNtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - ntp summary: Read a 'ntp.Policy' resource. operationId: GetNtpPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ntp.Policy - 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 'ntp.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ntp.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ntp/Policies/{Moid}: get: tags: - ntp summary: Read a 'ntp.Policy' resource. operationId: GetNtpPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.ntp.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ntp.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ntp.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetNtpPolicyByMoid: operationId: GetNtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ntp summary: Update a 'ntp.Policy' resource. operationId: UpdateNtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.ntp.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ntp.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ntp.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ntp.Policy' resource was modified as requested. The 'ntp.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ntp.Policy' links: GetNtpPolicyByMoid: operationId: GetNtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ntp.Policy' resource is asynchronously being modified 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/ntp.Policy' links: GetNtpPolicyByMoid: operationId: GetNtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ntp summary: Update a 'ntp.Policy' resource. operationId: PatchNtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.ntp.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ntp.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ntp.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 'ntp.Policy' resource was patched as requested. The 'ntp.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ntp.Policy' links: GetNtpPolicyByMoid: operationId: GetNtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ntp.Policy' resource is asynchronously being patched 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/ntp.Policy' links: GetNtpPolicyByMoid: operationId: GetNtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - ntp summary: Delete a 'ntp.Policy' resource. operationId: DeleteNtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.ntp.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'organization.Organization' 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/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 summary: Read a 'organization.Organization' resource. operationId: GetOrganizationOrganizationList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Organizations - PRIVSET.Read-Only - PRIVSET.View Organizations - READ.organization.Organization - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/organization.Organization.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/organization.Organization' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'organization.Organization' resource is asynchronously being modified 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/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 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'organization.Organization' resource is asynchronously being patched 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/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 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 summary: Read a 'organization.Organization' resource. operationId: GetOrganizationOrganizationByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Organizations - PRIVSET.Read-Only - PRIVSET.View Organizations - READ.organization.Organization - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/os/Catalogs: get: tags: - os summary: Read a 'os.Catalog' resource. operationId: GetOsCatalogList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Servers - READ.os.Catalog - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'os.Catalog' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/os.Catalog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/Catalogs/{Moid}: get: tags: - os summary: Read a 'os.Catalog' resource. operationId: GetOsCatalogByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Servers - READ.os.Catalog - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'os.Catalog' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/os.Catalog' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetOsCatalogByMoid: operationId: GetOsCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Catalogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/ConfigurationFiles: get: tags: - os summary: Read a 'os.ConfigurationFile' resource. operationId: GetOsConfigurationFileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.os.ConfigurationFile - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'os.ConfigurationFile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/os.ConfigurationFile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - os summary: Create a 'os.ConfigurationFile' resource. operationId: CreateOsConfigurationFile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.os.ConfigurationFile - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'os.ConfigurationFile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/os.ConfigurationFile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'os.ConfigurationFile' resource was created as requested. The 'os.ConfigurationFile' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/os.ConfigurationFile' links: GetOsConfigurationFileByMoid: operationId: GetOsConfigurationFileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ConfigurationFiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'os.ConfigurationFile' 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/os.ConfigurationFile' links: GetOsConfigurationFileByMoid: operationId: GetOsConfigurationFileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ConfigurationFiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/ConfigurationFiles/{Moid}: get: tags: - os summary: Read a 'os.ConfigurationFile' resource. operationId: GetOsConfigurationFileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.os.ConfigurationFile - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'os.ConfigurationFile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/os.ConfigurationFile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetOsConfigurationFileByMoid: operationId: GetOsConfigurationFileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ConfigurationFiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - os summary: Delete a 'os.ConfigurationFile' resource. operationId: DeleteOsConfigurationFile security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.os.ConfigurationFile - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/os/Distributions: get: tags: - os summary: Read a 'os.Distribution' resource. operationId: GetOsDistributionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.os.Distribution - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'os.Distribution' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/os.Distribution.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/Distributions/{Moid}: get: tags: - os summary: Read a 'os.Distribution' resource. operationId: GetOsDistributionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.os.Distribution - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'os.Distribution' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/os.Distribution' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetOsDistributionByMoid: operationId: GetOsDistributionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Distributions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/Installs: get: tags: - os summary: Read a 'os.Install' resource. operationId: GetOsInstallList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.os.Install - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'os.Install' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/os.Install.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - os summary: Create a 'os.Install' resource. operationId: CreateOsInstall security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.os.Install - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'os.Install' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/os.Install' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'os.Install' resource was created as requested. The 'os.Install' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/os.Install' links: GetOsInstallByMoid: operationId: GetOsInstallByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Installs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'os.Install' 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/os.Install' links: GetOsInstallByMoid: operationId: GetOsInstallByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Installs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/Installs/{Moid}: get: tags: - os summary: Read a 'os.Install' resource. operationId: GetOsInstallByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.os.Install - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'os.Install' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/os.Install' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetOsInstallByMoid: operationId: GetOsInstallByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Installs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/OsSupports: post: tags: - os summary: Create a 'os.OsSupport' resource. operationId: CreateOsOsSupport security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.os.OsSupport - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'os.OsSupport' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/os.OsSupport' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'os.OsSupport' resource was created as requested. The 'os.OsSupport' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/os.OsSupport' links: GetOsOsSupportByMoid: operationId: GetOsOsSupportByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/OsSupports/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'os.OsSupport' 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/os.OsSupport' links: GetOsOsSupportByMoid: operationId: GetOsOsSupportByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/OsSupports/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/os/TemplateFiles: post: tags: - os summary: Create a 'os.TemplateFile' resource. operationId: CreateOsTemplateFile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.os.TemplateFile - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'os.TemplateFile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/os.TemplateFile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'os.TemplateFile' resource was created as requested. The 'os.TemplateFile' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/os.TemplateFile' links: GetOsTemplateFileByMoid: operationId: GetOsTemplateFileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/TemplateFiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'os.TemplateFile' 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/os.TemplateFile' links: GetOsTemplateFileByMoid: operationId: GetOsTemplateFileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/TemplateFiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/CoprocessorCards: get: tags: - pci summary: Read a 'pci.CoprocessorCard' resource. operationId: GetPciCoprocessorCardList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.CoprocessorCard - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'pci.CoprocessorCard' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/pci.CoprocessorCard.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/CoprocessorCards/{Moid}: get: tags: - pci summary: Read a 'pci.CoprocessorCard' resource. operationId: GetPciCoprocessorCardByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.CoprocessorCard - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'pci.CoprocessorCard' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/pci.CoprocessorCard' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetPciCoprocessorCardByMoid: operationId: GetPciCoprocessorCardByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/CoprocessorCards/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/Devices: get: tags: - pci summary: Read a 'pci.Device' resource. operationId: GetPciDeviceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.Device - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'pci.Device' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/pci.Device.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/Devices/{Moid}: get: tags: - pci summary: Read a 'pci.Device' resource. operationId: GetPciDeviceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.Device - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'pci.Device' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/pci.Device' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetPciDeviceByMoid: operationId: GetPciDeviceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - pci summary: Update a 'pci.Device' resource. operationId: UpdatePciDevice security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.pci.Device parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'pci.Device' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/pci.Device' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Device' resource was modified as requested. The 'pci.Device' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/pci.Device' links: GetPciDeviceByMoid: operationId: GetPciDeviceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'pci.Device' resource is asynchronously being modified 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/pci.Device' links: GetPciDeviceByMoid: operationId: GetPciDeviceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - pci summary: Update a 'pci.Device' resource. operationId: PatchPciDevice security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.pci.Device parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'pci.Device' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/pci.Device' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Device' resource was patched as requested. The 'pci.Device' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/pci.Device' links: GetPciDeviceByMoid: operationId: GetPciDeviceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'pci.Device' resource is asynchronously being patched 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/pci.Device' links: GetPciDeviceByMoid: operationId: GetPciDeviceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/Links: get: tags: - pci summary: Read a 'pci.Link' resource. operationId: GetPciLinkList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.Link - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'pci.Link' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/pci.Link.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/Links/{Moid}: get: tags: - pci summary: Read a 'pci.Link' resource. operationId: GetPciLinkByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.Link - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'pci.Link' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/pci.Link' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetPciLinkByMoid: operationId: GetPciLinkByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - pci summary: Update a 'pci.Link' resource. operationId: UpdatePciLink security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.pci.Link parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'pci.Link' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/pci.Link' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Link' resource was modified as requested. The 'pci.Link' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/pci.Link' links: GetPciLinkByMoid: operationId: GetPciLinkByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'pci.Link' resource is asynchronously being modified 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/pci.Link' links: GetPciLinkByMoid: operationId: GetPciLinkByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - pci summary: Update a 'pci.Link' resource. operationId: PatchPciLink security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.pci.Link parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'pci.Link' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/pci.Link' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Link' resource was patched as requested. The 'pci.Link' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/pci.Link' links: GetPciLinkByMoid: operationId: GetPciLinkByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'pci.Link' resource is asynchronously being patched 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/pci.Link' links: GetPciLinkByMoid: operationId: GetPciLinkByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/Switches: get: tags: - pci summary: Read a 'pci.Switch' resource. operationId: GetPciSwitchList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.Switch - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'pci.Switch' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/pci.Switch.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/pci/Switches/{Moid}: get: tags: - pci summary: Read a 'pci.Switch' resource. operationId: GetPciSwitchByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.pci.Switch - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'pci.Switch' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/pci.Switch' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetPciSwitchByMoid: operationId: GetPciSwitchByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - pci summary: Update a 'pci.Switch' resource. operationId: UpdatePciSwitch security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.pci.Switch parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'pci.Switch' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/pci.Switch' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Switch' resource was modified as requested. The 'pci.Switch' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/pci.Switch' links: GetPciSwitchByMoid: operationId: GetPciSwitchByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'pci.Switch' resource is asynchronously being modified 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/pci.Switch' links: GetPciSwitchByMoid: operationId: GetPciSwitchByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - pci summary: Update a 'pci.Switch' resource. operationId: PatchPciSwitch security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.pci.Switch parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'pci.Switch' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/pci.Switch' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Switch' resource was patched as requested. The 'pci.Switch' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/pci.Switch' links: GetPciSwitchByMoid: operationId: GetPciSwitchByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'pci.Switch' resource is asynchronously being patched 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/pci.Switch' links: GetPciSwitchByMoid: operationId: GetPciSwitchByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/port/Groups: get: tags: - port summary: Read a 'port.Group' resource. operationId: GetPortGroupList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.port.Group - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'port.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: # Response as JSON document. schema: $ref: '#/components/schemas/port.Group.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/port/Groups/{Moid}: get: tags: - port summary: Read a 'port.Group' resource. operationId: GetPortGroupByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.port.Group - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'port.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/port.Group' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetPortGroupByMoid: operationId: GetPortGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/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' post: tags: - port summary: Update a 'port.Group' resource. operationId: UpdatePortGroup security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.port.Group parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'port.Group' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/port.Group' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'port.Group' resource was modified as requested. The 'port.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/port.Group' links: GetPortGroupByMoid: operationId: GetPortGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/Groups/{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 'port.Group' resource is asynchronously being modified 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/port.Group' links: GetPortGroupByMoid: operationId: GetPortGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/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: - port summary: Update a 'port.Group' resource. operationId: PatchPortGroup security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.port.Group parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'port.Group' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/port.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 'port.Group' resource was patched as requested. The 'port.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/port.Group' links: GetPortGroupByMoid: operationId: GetPortGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/Groups/{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 'port.Group' resource is asynchronously being patched 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/port.Group' links: GetPortGroupByMoid: operationId: GetPortGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/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/port/MacBindings: get: tags: - port summary: Read a 'port.MacBinding' resource. operationId: GetPortMacBindingList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.port.MacBinding parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'port.MacBinding' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/port.MacBinding.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/port/MacBindings/{Moid}: get: tags: - port summary: Read a 'port.MacBinding' resource. operationId: GetPortMacBindingByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.port.MacBinding parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'port.MacBinding' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/port.MacBinding' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetPortMacBindingByMoid: operationId: GetPortMacBindingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/MacBindings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - port summary: Update a 'port.MacBinding' resource. operationId: UpdatePortMacBinding security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.port.MacBinding parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'port.MacBinding' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/port.MacBinding' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'port.MacBinding' resource was modified as requested. The 'port.MacBinding' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/port.MacBinding' links: GetPortMacBindingByMoid: operationId: GetPortMacBindingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/MacBindings/{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 'port.MacBinding' resource is asynchronously being modified 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/port.MacBinding' links: GetPortMacBindingByMoid: operationId: GetPortMacBindingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/MacBindings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - port summary: Update a 'port.MacBinding' resource. operationId: PatchPortMacBinding security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.port.MacBinding parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'port.MacBinding' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/port.MacBinding' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'port.MacBinding' resource was patched as requested. The 'port.MacBinding' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/port.MacBinding' links: GetPortMacBindingByMoid: operationId: GetPortMacBindingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/MacBindings/{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 'port.MacBinding' resource is asynchronously being patched 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/port.MacBinding' links: GetPortMacBindingByMoid: operationId: GetPortMacBindingByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/MacBindings/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/port/SubGroups: get: tags: - port summary: Read a 'port.SubGroup' resource. operationId: GetPortSubGroupList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.port.SubGroup - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - 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 'port.SubGroup' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/port.SubGroup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/port/SubGroups/{Moid}: get: tags: - port summary: Read a 'port.SubGroup' resource. operationId: GetPortSubGroupByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - READ.port.SubGroup - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'port.SubGroup' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/port.SubGroup' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetPortSubGroupByMoid: operationId: GetPortSubGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/SubGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - port summary: Update a 'port.SubGroup' resource. operationId: UpdatePortSubGroup security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.port.SubGroup parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'port.SubGroup' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/port.SubGroup' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'port.SubGroup' resource was modified as requested. The 'port.SubGroup' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/port.SubGroup' links: GetPortSubGroupByMoid: operationId: GetPortSubGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/SubGroups/{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 'port.SubGroup' resource is asynchronously being modified 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/port.SubGroup' links: GetPortSubGroupByMoid: operationId: GetPortSubGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/SubGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - port summary: Update a 'port.SubGroup' resource. operationId: PatchPortSubGroup security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - ROLE.Account Administrator - UPDATE.port.SubGroup parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'port.SubGroup' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/port.SubGroup' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'port.SubGroup' resource was patched as requested. The 'port.SubGroup' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/port.SubGroup' links: GetPortSubGroupByMoid: operationId: GetPortSubGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/SubGroups/{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 'port.SubGroup' resource is asynchronously being patched 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/port.SubGroup' links: GetPortSubGroupByMoid: operationId: GetPortSubGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/port/SubGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/processor/Units: get: tags: - processor summary: Read a 'processor.Unit' resource. operationId: GetProcessorUnitList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.processor.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'processor.Unit' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/processor.Unit.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/processor/Units/{Moid}: get: tags: - processor summary: Read a 'processor.Unit' resource. operationId: GetProcessorUnitByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.processor.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'processor.Unit' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/processor.Unit' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetProcessorUnitByMoid: operationId: GetProcessorUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - processor summary: Update a 'processor.Unit' resource. operationId: UpdateProcessorUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.processor.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'processor.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/processor.Unit' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'processor.Unit' resource was modified as requested. The 'processor.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/processor.Unit' links: GetProcessorUnitByMoid: operationId: GetProcessorUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'processor.Unit' resource is asynchronously being modified 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/processor.Unit' links: GetProcessorUnitByMoid: operationId: GetProcessorUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - processor summary: Update a 'processor.Unit' resource. operationId: PatchProcessorUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.processor.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'processor.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/processor.Unit' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'processor.Unit' resource was patched as requested. The 'processor.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/processor.Unit' links: GetProcessorUnitByMoid: operationId: GetProcessorUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'processor.Unit' resource is asynchronously being patched 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/processor.Unit' links: GetProcessorUnitByMoid: operationId: GetProcessorUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.BackupConfigPolicy' 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/recovery.BackupConfigPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/recovery.BackupConfigPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.BackupConfigPolicy' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.BackupConfigPolicy' resource is asynchronously being patched 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/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.BackupProfile' 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/recovery.BackupProfile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/recovery.BackupProfile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.BackupProfile' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.BackupProfile' resource is asynchronously being patched 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/recovery.ConfigResult.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # Response as JSON document. schema: $ref: '#/components/schemas/recovery.ConfigResultEntry.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.OnDemandBackup' 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/recovery.OnDemandBackup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/recovery.OnDemandBackup' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.OnDemandBackup' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.OnDemandBackup' resource is asynchronously being patched 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/recovery.Restore.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.Restore' 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/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.ScheduleConfigPolicy' 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/recovery.ScheduleConfigPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/recovery.ScheduleConfigPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.ScheduleConfigPolicy' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'recovery.ScheduleConfigPolicy' resource is asynchronously being patched 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/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'resource.Group' 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/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-Only - PRIVSET.View Organizations - READ.resource.Group - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/resource.Group.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/resource.Group' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'resource.Group' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'resource.Group' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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-Only - PRIVSET.View Organizations - READ.resource.Group - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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-Only - PRIVSET.View Organizations - READ.resource.GroupMember - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/resource.GroupMember.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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-Only - PRIVSET.View Organizations - READ.resource.GroupMember - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # Response as JSON document. schema: $ref: '#/components/schemas/resource.LicenseResourceCount.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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 summary: Read a 'resource.Membership' resource. operationId: GetResourceMembershipList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.resource.Membership parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/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: # Response as JSON document. schema: $ref: '#/components/schemas/resource.Membership.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 summary: Read a 'resource.Membership' resource. operationId: GetResourceMembershipByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.resource.Membership parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' /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: # Response as JSON document. schema: $ref: '#/components/schemas/resource.MembershipHolder.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/sdcard/Policies: get: tags: - sdcard summary: Read a 'sdcard.Policy' resource. operationId: GetSdcardPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.sdcard.Policy - 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 'sdcard.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/sdcard.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdcard summary: Create a 'sdcard.Policy' resource. operationId: CreateSdcardPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.sdcard.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'sdcard.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/sdcard.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdcard.Policy' resource was created as requested. The 'sdcard.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdcard.Policy' links: GetSdcardPolicyByMoid: operationId: GetSdcardPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'sdcard.Policy' 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/sdcard.Policy' links: GetSdcardPolicyByMoid: operationId: GetSdcardPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/sdcard/Policies/{Moid}: get: tags: - sdcard summary: Read a 'sdcard.Policy' resource. operationId: GetSdcardPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.sdcard.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'sdcard.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/sdcard.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSdcardPolicyByMoid: operationId: GetSdcardPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdcard summary: Update a 'sdcard.Policy' resource. operationId: UpdateSdcardPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.sdcard.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdcard.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdcard.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdcard.Policy' resource was modified as requested. The 'sdcard.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdcard.Policy' links: GetSdcardPolicyByMoid: operationId: GetSdcardPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'sdcard.Policy' resource is asynchronously being modified 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/sdcard.Policy' links: GetSdcardPolicyByMoid: operationId: GetSdcardPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - sdcard summary: Update a 'sdcard.Policy' resource. operationId: PatchSdcardPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.sdcard.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdcard.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdcard.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 'sdcard.Policy' resource was patched as requested. The 'sdcard.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdcard.Policy' links: GetSdcardPolicyByMoid: operationId: GetSdcardPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'sdcard.Policy' resource is asynchronously being patched 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/sdcard.Policy' links: GetSdcardPolicyByMoid: operationId: GetSdcardPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - sdcard summary: Delete a 'sdcard.Policy' resource. operationId: DeleteSdcardPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.sdcard.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/sdwan/Profiles: get: tags: - sdwan summary: Read a 'sdwan.Profile' resource. operationId: GetSdwanProfileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.Profile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'sdwan.Profile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/sdwan.Profile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Create a 'sdwan.Profile' resource. operationId: CreateSdwanProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.sdwan.Profile - PRIVSET.Account Administrator - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'sdwan.Profile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/sdwan.Profile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.Profile' resource was created as requested. The 'sdwan.Profile' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.Profile' links: GetSdwanProfileByMoid: operationId: GetSdwanProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/Profiles/{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 'sdwan.Profile' 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/sdwan.Profile' links: GetSdwanProfileByMoid: operationId: GetSdwanProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/sdwan/Profiles/{Moid}: get: tags: - sdwan summary: Read a 'sdwan.Profile' resource. operationId: GetSdwanProfileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.Profile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'sdwan.Profile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/sdwan.Profile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSdwanProfileByMoid: operationId: GetSdwanProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Update a 'sdwan.Profile' resource. operationId: UpdateSdwanProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.Profile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.Profile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.Profile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.Profile' resource was modified as requested. The 'sdwan.Profile' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.Profile' links: GetSdwanProfileByMoid: operationId: GetSdwanProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/Profiles/{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 'sdwan.Profile' resource is asynchronously being modified 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/sdwan.Profile' links: GetSdwanProfileByMoid: operationId: GetSdwanProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - sdwan summary: Update a 'sdwan.Profile' resource. operationId: PatchSdwanProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.Profile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.Profile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.Profile' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.Profile' resource was patched as requested. The 'sdwan.Profile' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.Profile' links: GetSdwanProfileByMoid: operationId: GetSdwanProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/Profiles/{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 'sdwan.Profile' resource is asynchronously being patched 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/sdwan.Profile' links: GetSdwanProfileByMoid: operationId: GetSdwanProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - sdwan summary: Delete a 'sdwan.Profile' resource. operationId: DeleteSdwanProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.sdwan.Profile - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/sdwan/RouterNodes: get: tags: - sdwan summary: Read a 'sdwan.RouterNode' resource. operationId: GetSdwanRouterNodeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.RouterNode - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'sdwan.RouterNode' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/sdwan.RouterNode.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Create a 'sdwan.RouterNode' resource. operationId: CreateSdwanRouterNode security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.sdwan.RouterNode - PRIVSET.Account Administrator - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'sdwan.RouterNode' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterNode' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.RouterNode' resource was created as requested. The 'sdwan.RouterNode' 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/sdwan.RouterNode' links: GetSdwanRouterNodeByMoid: operationId: GetSdwanRouterNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterNodes/{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 'sdwan.RouterNode' 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/sdwan.RouterNode' links: GetSdwanRouterNodeByMoid: operationId: GetSdwanRouterNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterNodes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/sdwan/RouterNodes/{Moid}: get: tags: - sdwan summary: Read a 'sdwan.RouterNode' resource. operationId: GetSdwanRouterNodeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.RouterNode - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'sdwan.RouterNode' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterNode' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSdwanRouterNodeByMoid: operationId: GetSdwanRouterNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterNodes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Update a 'sdwan.RouterNode' resource. operationId: UpdateSdwanRouterNode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.RouterNode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.RouterNode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.RouterNode' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.RouterNode' resource was modified as requested. The 'sdwan.RouterNode' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterNode' links: GetSdwanRouterNodeByMoid: operationId: GetSdwanRouterNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterNodes/{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 'sdwan.RouterNode' resource is asynchronously being modified 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/sdwan.RouterNode' links: GetSdwanRouterNodeByMoid: operationId: GetSdwanRouterNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterNodes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - sdwan summary: Update a 'sdwan.RouterNode' resource. operationId: PatchSdwanRouterNode security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.RouterNode parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.RouterNode' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.RouterNode' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.RouterNode' resource was patched as requested. The 'sdwan.RouterNode' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterNode' links: GetSdwanRouterNodeByMoid: operationId: GetSdwanRouterNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterNodes/{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 'sdwan.RouterNode' resource is asynchronously being patched 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/sdwan.RouterNode' links: GetSdwanRouterNodeByMoid: operationId: GetSdwanRouterNodeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterNodes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - sdwan summary: Delete a 'sdwan.RouterNode' resource. operationId: DeleteSdwanRouterNode security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.sdwan.RouterNode - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/sdwan/RouterPolicies: get: tags: - sdwan summary: Read a 'sdwan.RouterPolicy' resource. operationId: GetSdwanRouterPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.RouterPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'sdwan.RouterPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/sdwan.RouterPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Create a 'sdwan.RouterPolicy' resource. operationId: CreateSdwanRouterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.sdwan.RouterPolicy - PRIVSET.Account Administrator - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'sdwan.RouterPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.RouterPolicy' resource was created as requested. The 'sdwan.RouterPolicy' 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/sdwan.RouterPolicy' links: GetSdwanRouterPolicyByMoid: operationId: GetSdwanRouterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterPolicies/{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 'sdwan.RouterPolicy' 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/sdwan.RouterPolicy' links: GetSdwanRouterPolicyByMoid: operationId: GetSdwanRouterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/sdwan/RouterPolicies/{Moid}: get: tags: - sdwan summary: Read a 'sdwan.RouterPolicy' resource. operationId: GetSdwanRouterPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.RouterPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'sdwan.RouterPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSdwanRouterPolicyByMoid: operationId: GetSdwanRouterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Update a 'sdwan.RouterPolicy' resource. operationId: UpdateSdwanRouterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.RouterPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.RouterPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.RouterPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.RouterPolicy' resource was modified as requested. The 'sdwan.RouterPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterPolicy' links: GetSdwanRouterPolicyByMoid: operationId: GetSdwanRouterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterPolicies/{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 'sdwan.RouterPolicy' resource is asynchronously being modified 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/sdwan.RouterPolicy' links: GetSdwanRouterPolicyByMoid: operationId: GetSdwanRouterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - sdwan summary: Update a 'sdwan.RouterPolicy' resource. operationId: PatchSdwanRouterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.RouterPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.RouterPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.RouterPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.RouterPolicy' resource was patched as requested. The 'sdwan.RouterPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.RouterPolicy' links: GetSdwanRouterPolicyByMoid: operationId: GetSdwanRouterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterPolicies/{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 'sdwan.RouterPolicy' resource is asynchronously being patched 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/sdwan.RouterPolicy' links: GetSdwanRouterPolicyByMoid: operationId: GetSdwanRouterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/RouterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - sdwan summary: Delete a 'sdwan.RouterPolicy' resource. operationId: DeleteSdwanRouterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.sdwan.RouterPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/sdwan/VmanageAccountPolicies: get: tags: - sdwan summary: Read a 'sdwan.VmanageAccountPolicy' resource. operationId: GetSdwanVmanageAccountPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.VmanageAccountPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'sdwan.VmanageAccountPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Create a 'sdwan.VmanageAccountPolicy' resource. operationId: CreateSdwanVmanageAccountPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.sdwan.VmanageAccountPolicy - PRIVSET.Account Administrator - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'sdwan.VmanageAccountPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.VmanageAccountPolicy' resource was created as requested. The 'sdwan.VmanageAccountPolicy' 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/sdwan.VmanageAccountPolicy' links: GetSdwanVmanageAccountPolicyByMoid: operationId: GetSdwanVmanageAccountPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/VmanageAccountPolicies/{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 'sdwan.VmanageAccountPolicy' 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/sdwan.VmanageAccountPolicy' links: GetSdwanVmanageAccountPolicyByMoid: operationId: GetSdwanVmanageAccountPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/VmanageAccountPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/sdwan/VmanageAccountPolicies/{Moid}: get: tags: - sdwan summary: Read a 'sdwan.VmanageAccountPolicy' resource. operationId: GetSdwanVmanageAccountPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.sdwan.VmanageAccountPolicy - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'sdwan.VmanageAccountPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSdwanVmanageAccountPolicyByMoid: operationId: GetSdwanVmanageAccountPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/VmanageAccountPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sdwan summary: Update a 'sdwan.VmanageAccountPolicy' resource. operationId: UpdateSdwanVmanageAccountPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.VmanageAccountPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.VmanageAccountPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.VmanageAccountPolicy' resource was modified as requested. The 'sdwan.VmanageAccountPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' links: GetSdwanVmanageAccountPolicyByMoid: operationId: GetSdwanVmanageAccountPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/VmanageAccountPolicies/{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 'sdwan.VmanageAccountPolicy' resource is asynchronously being modified 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/sdwan.VmanageAccountPolicy' links: GetSdwanVmanageAccountPolicyByMoid: operationId: GetSdwanVmanageAccountPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/VmanageAccountPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - sdwan summary: Update a 'sdwan.VmanageAccountPolicy' resource. operationId: PatchSdwanVmanageAccountPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.sdwan.VmanageAccountPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sdwan.VmanageAccountPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sdwan.VmanageAccountPolicy' resource was patched as requested. The 'sdwan.VmanageAccountPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' links: GetSdwanVmanageAccountPolicyByMoid: operationId: GetSdwanVmanageAccountPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/VmanageAccountPolicies/{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 'sdwan.VmanageAccountPolicy' resource is asynchronously being patched 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/sdwan.VmanageAccountPolicy' links: GetSdwanVmanageAccountPolicyByMoid: operationId: GetSdwanVmanageAccountPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdwan/VmanageAccountPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - sdwan summary: Delete a 'sdwan.VmanageAccountPolicy' resource. operationId: DeleteSdwanVmanageAccountPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.sdwan.VmanageAccountPolicy - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/search.SearchItem.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: - READ.search.SearchItem parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/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: >- The HTTP 200 status response code indicates that the request has succeeded and the 'search.SuggestItem' resource was created as requested. The 'search.SuggestItem' 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/search.SuggestItem' links: GetSearchSuggestItemByMoid: operationId: GetSearchSuggestItemByMoid 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/SuggestItems/{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 'search.SuggestItem' 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/search.SuggestItem' links: GetSearchSuggestItemByMoid: operationId: GetSearchSuggestItemByMoid 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/SuggestItems/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: - 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: # Response as JSON document. schema: $ref: '#/components/schemas/search.TagItem.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: - READ.search.TagItem parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/security/Units: get: tags: - security summary: Read a 'security.Unit' resource. operationId: GetSecurityUnitList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.security.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'security.Unit' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/security.Unit.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/security/Units/{Moid}: get: tags: - security summary: Read a 'security.Unit' resource. operationId: GetSecurityUnitByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.security.Unit - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'security.Unit' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/security.Unit' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSecurityUnitByMoid: operationId: GetSecurityUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - security summary: Update a 'security.Unit' resource. operationId: UpdateSecurityUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.security.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'security.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/security.Unit' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'security.Unit' resource was modified as requested. The 'security.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/security.Unit' links: GetSecurityUnitByMoid: operationId: GetSecurityUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'security.Unit' resource is asynchronously being modified 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/security.Unit' links: GetSecurityUnitByMoid: operationId: GetSecurityUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - security summary: Update a 'security.Unit' resource. operationId: PatchSecurityUnit security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.security.Unit parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'security.Unit' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/security.Unit' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'security.Unit' resource was patched as requested. The 'security.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/security.Unit' links: GetSecurityUnitByMoid: operationId: GetSecurityUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'security.Unit' resource is asynchronously being patched 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/security.Unit' links: GetSecurityUnitByMoid: operationId: GetSecurityUnitByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigChangeDetails: get: tags: - server summary: Read a 'server.ConfigChangeDetail' resource. operationId: GetServerConfigChangeDetailList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigChangeDetail - 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 'server.ConfigChangeDetail' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/server.ConfigChangeDetail.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigChangeDetails/{Moid}: get: tags: - server summary: Read a 'server.ConfigChangeDetail' resource. operationId: GetServerConfigChangeDetailByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigChangeDetail - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'server.ConfigChangeDetail' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/server.ConfigChangeDetail' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetServerConfigChangeDetailByMoid: operationId: GetServerConfigChangeDetailByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigChangeDetails/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigImports: get: tags: - server summary: Read a 'server.ConfigImport' resource. operationId: GetServerConfigImportList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigImport - 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 'server.ConfigImport' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/server.ConfigImport.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - server summary: Create a 'server.ConfigImport' resource. operationId: CreateServerConfigImport security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.server.ConfigImport - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'server.ConfigImport' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/server.ConfigImport' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'server.ConfigImport' resource was created as requested. The 'server.ConfigImport' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/server.ConfigImport' links: GetServerConfigImportByMoid: operationId: GetServerConfigImportByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigImports/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'server.ConfigImport' 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/server.ConfigImport' links: GetServerConfigImportByMoid: operationId: GetServerConfigImportByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigImports/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigImports/{Moid}: get: tags: - server summary: Read a 'server.ConfigImport' resource. operationId: GetServerConfigImportByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigImport - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'server.ConfigImport' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/server.ConfigImport' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetServerConfigImportByMoid: operationId: GetServerConfigImportByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigImports/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigResults: get: tags: - server summary: Read a 'server.ConfigResult' resource. operationId: GetServerConfigResultList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigResult - 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 'server.ConfigResult' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/server.ConfigResult.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigResults/{Moid}: get: tags: - server summary: Read a 'server.ConfigResult' resource. operationId: GetServerConfigResultByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigResult - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'server.ConfigResult' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/server.ConfigResult' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetServerConfigResultByMoid: operationId: GetServerConfigResultByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigResults/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigResultEntries: get: tags: - server summary: Read a 'server.ConfigResultEntry' resource. operationId: GetServerConfigResultEntryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigResultEntry - 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 'server.ConfigResultEntry' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/server.ConfigResultEntry.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/ConfigResultEntries/{Moid}: get: tags: - server summary: Read a 'server.ConfigResultEntry' resource. operationId: GetServerConfigResultEntryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.ConfigResultEntry - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'server.ConfigResultEntry' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/server.ConfigResultEntry' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetServerConfigResultEntryByMoid: operationId: GetServerConfigResultEntryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigResultEntries/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/Profiles: get: tags: - server summary: Read a 'server.Profile' resource. operationId: GetServerProfileList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.Profile - 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 'server.Profile' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/server.Profile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - server summary: Create a 'server.Profile' resource. operationId: CreateServerProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.server.Profile - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'server.Profile' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/server.Profile' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'server.Profile' resource was created as requested. The 'server.Profile' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/server.Profile' links: GetServerProfileByMoid: operationId: GetServerProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'server.Profile' 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/server.Profile' links: GetServerProfileByMoid: operationId: GetServerProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/server/Profiles/{Moid}: get: tags: - server summary: Read a 'server.Profile' resource. operationId: GetServerProfileByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.server.Profile - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'server.Profile' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/server.Profile' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetServerProfileByMoid: operationId: GetServerProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - server summary: Update a 'server.Profile' resource. operationId: UpdateServerProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.server.Profile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'server.Profile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/server.Profile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'server.Profile' resource was modified as requested. The 'server.Profile' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/server.Profile' links: GetServerProfileByMoid: operationId: GetServerProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'server.Profile' resource is asynchronously being modified 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/server.Profile' links: GetServerProfileByMoid: operationId: GetServerProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - server summary: Update a 'server.Profile' resource. operationId: PatchServerProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.server.Profile parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'server.Profile' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/server.Profile' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'server.Profile' resource was patched as requested. The 'server.Profile' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/server.Profile' links: GetServerProfileByMoid: operationId: GetServerProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'server.Profile' resource is asynchronously being patched 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/server.Profile' links: GetServerProfileByMoid: operationId: GetServerProfileByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - server summary: Delete a 'server.Profile' resource. operationId: DeleteServerProfile security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.server.Profile - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/smtp/Policies: post: tags: - smtp summary: Create a 'smtp.Policy' resource. operationId: CreateSmtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.smtp.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'smtp.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/smtp.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.Policy' resource was created as requested. The 'smtp.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/smtp.Policy' links: GetSmtpPolicyByMoid: operationId: GetSmtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'smtp.Policy' 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/smtp.Policy' links: GetSmtpPolicyByMoid: operationId: GetSmtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - smtp summary: Read a 'smtp.Policy' resource. operationId: GetSmtpPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.smtp.Policy - 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 'smtp.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/smtp.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/smtp/Policies/{Moid}: get: tags: - smtp summary: Read a 'smtp.Policy' resource. operationId: GetSmtpPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.smtp.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'smtp.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/smtp.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSmtpPolicyByMoid: operationId: GetSmtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - smtp summary: Update a 'smtp.Policy' resource. operationId: UpdateSmtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.smtp.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'smtp.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/smtp.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.Policy' resource was modified as requested. The 'smtp.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/smtp.Policy' links: GetSmtpPolicyByMoid: operationId: GetSmtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'smtp.Policy' resource is asynchronously being modified 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/smtp.Policy' links: GetSmtpPolicyByMoid: operationId: GetSmtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - smtp summary: Update a 'smtp.Policy' resource. operationId: PatchSmtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.smtp.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'smtp.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/smtp.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 'smtp.Policy' resource was patched as requested. The 'smtp.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/smtp.Policy' links: GetSmtpPolicyByMoid: operationId: GetSmtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'smtp.Policy' resource is asynchronously being patched 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/smtp.Policy' links: GetSmtpPolicyByMoid: operationId: GetSmtpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - smtp summary: Delete a 'smtp.Policy' resource. operationId: DeleteSmtpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.smtp.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/snmp/Policies: post: tags: - snmp summary: Create a 'snmp.Policy' resource. operationId: CreateSnmpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.snmp.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'snmp.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/snmp.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'snmp.Policy' resource was created as requested. The 'snmp.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/snmp.Policy' links: GetSnmpPolicyByMoid: operationId: GetSnmpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'snmp.Policy' 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/snmp.Policy' links: GetSnmpPolicyByMoid: operationId: GetSnmpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - snmp summary: Read a 'snmp.Policy' resource. operationId: GetSnmpPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.snmp.Policy - 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 'snmp.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/snmp.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/snmp/Policies/{Moid}: get: tags: - snmp summary: Read a 'snmp.Policy' resource. operationId: GetSnmpPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.snmp.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'snmp.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/snmp.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSnmpPolicyByMoid: operationId: GetSnmpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - snmp summary: Update a 'snmp.Policy' resource. operationId: UpdateSnmpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.snmp.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'snmp.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/snmp.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'snmp.Policy' resource was modified as requested. The 'snmp.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/snmp.Policy' links: GetSnmpPolicyByMoid: operationId: GetSnmpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'snmp.Policy' resource is asynchronously being modified 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/snmp.Policy' links: GetSnmpPolicyByMoid: operationId: GetSnmpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - snmp summary: Update a 'snmp.Policy' resource. operationId: PatchSnmpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.snmp.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'snmp.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/snmp.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 'snmp.Policy' resource was patched as requested. The 'snmp.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/snmp.Policy' links: GetSnmpPolicyByMoid: operationId: GetSnmpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'snmp.Policy' resource is asynchronously being patched 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/snmp.Policy' links: GetSnmpPolicyByMoid: operationId: GetSnmpPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - snmp summary: Delete a 'snmp.Policy' resource. operationId: DeleteSnmpPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.snmp.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/software.ApplianceDistributable.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.ApplianceDistributable' 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/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/software.ApplianceDistributable' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.ApplianceDistributable' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.ApplianceDistributable' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: # Response as JSON document. schema: $ref: '#/components/schemas/software.HclMeta.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.HclMeta' resource. operationId: CreateSoftwareHclMeta security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.software.HclMeta parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'software.HclMeta' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/software.HclMeta' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'software.HclMeta' resource was created as requested. The 'software.HclMeta' 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.HclMeta' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HclMeta' 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/software.HclMeta' 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/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' post: tags: - software summary: Update a 'software.HclMeta' resource. operationId: UpdateSoftwareHclMeta security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.software.HclMeta parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'software.HclMeta' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/software.HclMeta' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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.HclMeta' resource was modified as requested. The 'software.HclMeta' resource is modified before this response is sent back and the resource is returned in the body of the message. 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.HclMeta' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HclMeta' resource is asynchronously being modified 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/software.HclMeta' 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' patch: tags: - software summary: Update a 'software.HclMeta' resource. operationId: PatchSoftwareHclMeta security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.software.HclMeta parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'software.HclMeta' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/software.HclMeta' application/json-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.HclMeta' resource was patched as requested. The 'software.HclMeta' resource is patched before this response is sent back and the resource is returned in the body of the message. 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.HclMeta' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HclMeta' resource is asynchronously being patched 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/software.HclMeta' 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' delete: tags: - software summary: Delete a 'software.HclMeta' resource. operationId: DeleteSoftwareHclMeta security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.software.HclMeta 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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.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: # Response as JSON document. schema: $ref: '#/components/schemas/software.HyperflexBundleDistributable.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HyperflexBundleDistributable' 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/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.View HyperFlex Cluster Profiles - READ.software.HyperflexBundleDistributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/software.HyperflexBundleDistributable' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HyperflexBundleDistributable' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HyperflexBundleDistributable' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.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: # Response as JSON document. schema: $ref: '#/components/schemas/software.HyperflexDistributable.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HyperflexDistributable' 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/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.View HyperFlex Cluster Profiles - READ.software.HyperflexDistributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/software.HyperflexDistributable' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HyperflexDistributable' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.HyperflexDistributable' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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 - 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: # Response as JSON document. schema: $ref: '#/components/schemas/software.SolutionDistributable.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.SolutionDistributable' 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/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 - READ.software.SolutionDistributable - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/software.SolutionDistributable' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.SolutionDistributable' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'software.SolutionDistributable' resource is asynchronously being patched 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/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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.Authorization' 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/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.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.softwarerepository.Authorization - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.Authorization.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.Authorization' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.Authorization' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.Authorization' resource is asynchronously being patched 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/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.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Fabric Interconnects - PRIVSET.View Servers - READ.softwarerepository.Authorization - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.View Fabric Interconnects - PRIVSET.View Servers - READ.softwarerepository.CachedImage - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.CachedImage.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Fabric Interconnects - PRIVSET.View Servers - READ.softwarerepository.CachedImage - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.View Fabric Interconnects - PRIVSET.View HyperFlex Cluster Profiles - PRIVSET.View Servers - READ.softwarerepository.Catalog - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.Catalog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Fabric Interconnects - PRIVSET.View HyperFlex Cluster Profiles - PRIVSET.View Servers - READ.softwarerepository.Catalog - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.CategoryMapper.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: Create a 'softwarerepository.CategoryMapper' resource. operationId: CreateSoftwarerepositoryCategoryMapper security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.softwarerepository.CategoryMapper parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'softwarerepository.CategoryMapper' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/softwarerepository.CategoryMapper' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.CategoryMapper' resource was created as requested. The 'softwarerepository.CategoryMapper' 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.CategoryMapper' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategoryMapper' 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/softwarerepository.CategoryMapper' 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/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' post: tags: - softwarerepository summary: Update a 'softwarerepository.CategoryMapper' resource. operationId: UpdateSoftwarerepositoryCategoryMapper security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.CategoryMapper parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.CategoryMapper' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.CategoryMapper' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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.CategoryMapper' resource was modified as requested. The 'softwarerepository.CategoryMapper' resource is modified before this response is sent back and the resource is returned in the body of the message. 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.CategoryMapper' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategoryMapper' resource is asynchronously being modified 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/softwarerepository.CategoryMapper' 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' patch: tags: - softwarerepository summary: Update a 'softwarerepository.CategoryMapper' resource. operationId: PatchSoftwarerepositoryCategoryMapper security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.CategoryMapper parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.CategoryMapper' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.CategoryMapper' application/json-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.CategoryMapper' resource was patched as requested. The 'softwarerepository.CategoryMapper' resource is patched before this response is sent back and the resource is returned in the body of the message. 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.CategoryMapper' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategoryMapper' resource is asynchronously being patched 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/softwarerepository.CategoryMapper' 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' delete: tags: - softwarerepository summary: Delete a 'softwarerepository.CategoryMapper' resource. operationId: DeleteSoftwarerepositoryCategoryMapper security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.softwarerepository.CategoryMapper 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.CategoryMapperModel.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: Create a 'softwarerepository.CategoryMapperModel' resource. operationId: CreateSoftwarerepositoryCategoryMapperModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.softwarerepository.CategoryMapperModel parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'softwarerepository.CategoryMapperModel' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/softwarerepository.CategoryMapperModel' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.CategoryMapperModel' resource was created as requested. The 'softwarerepository.CategoryMapperModel' 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.CategoryMapperModel' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategoryMapperModel' 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/softwarerepository.CategoryMapperModel' 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/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' post: tags: - softwarerepository summary: Update a 'softwarerepository.CategoryMapperModel' resource. operationId: UpdateSoftwarerepositoryCategoryMapperModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.CategoryMapperModel parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.CategoryMapperModel' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.CategoryMapperModel' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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.CategoryMapperModel' resource was modified as requested. The 'softwarerepository.CategoryMapperModel' resource is modified before this response is sent back and the resource is returned in the body of the message. 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.CategoryMapperModel' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategoryMapperModel' resource is asynchronously being modified 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/softwarerepository.CategoryMapperModel' 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' patch: tags: - softwarerepository summary: Update a 'softwarerepository.CategoryMapperModel' resource. operationId: PatchSoftwarerepositoryCategoryMapperModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.CategoryMapperModel parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.CategoryMapperModel' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.CategoryMapperModel' application/json-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.CategoryMapperModel' resource was patched as requested. The 'softwarerepository.CategoryMapperModel' resource is patched before this response is sent back and the resource is returned in the body of the message. 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.CategoryMapperModel' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategoryMapperModel' resource is asynchronously being patched 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/softwarerepository.CategoryMapperModel' 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' delete: tags: - softwarerepository summary: Delete a 'softwarerepository.CategoryMapperModel' resource. operationId: DeleteSoftwarerepositoryCategoryMapperModel security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.softwarerepository.CategoryMapperModel 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.CategorySupportConstraint.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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: Create a 'softwarerepository.CategorySupportConstraint' resource. operationId: CreateSoftwarerepositoryCategorySupportConstraint security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.softwarerepository.CategorySupportConstraint parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'softwarerepository.CategorySupportConstraint' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/softwarerepository.CategorySupportConstraint' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.CategorySupportConstraint' resource was created as requested. The 'softwarerepository.CategorySupportConstraint' 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.CategorySupportConstraint' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategorySupportConstraint' 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/softwarerepository.CategorySupportConstraint' 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/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' post: tags: - softwarerepository summary: Update a 'softwarerepository.CategorySupportConstraint' resource. operationId: UpdateSoftwarerepositoryCategorySupportConstraint security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.CategorySupportConstraint parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.CategorySupportConstraint' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.CategorySupportConstraint' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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.CategorySupportConstraint' resource was modified as requested. The 'softwarerepository.CategorySupportConstraint' resource is modified before this response is sent back and the resource is returned in the body of the message. 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.CategorySupportConstraint' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategorySupportConstraint' resource is asynchronously being modified 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/softwarerepository.CategorySupportConstraint' 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' patch: tags: - softwarerepository summary: Update a 'softwarerepository.CategorySupportConstraint' resource. operationId: PatchSoftwarerepositoryCategorySupportConstraint security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.CategorySupportConstraint parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.CategorySupportConstraint' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.CategorySupportConstraint' application/json-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.CategorySupportConstraint' resource was patched as requested. The 'softwarerepository.CategorySupportConstraint' resource is patched before this response is sent back and the resource is returned in the body of the message. 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.CategorySupportConstraint' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.CategorySupportConstraint' resource is asynchronously being patched 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/softwarerepository.CategorySupportConstraint' 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' delete: tags: - softwarerepository summary: Delete a 'softwarerepository.CategorySupportConstraint' resource. operationId: DeleteSoftwarerepositoryCategorySupportConstraint security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.softwarerepository.CategorySupportConstraint 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.DownloadSpec.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.OperatingSystemFile' 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/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.Manage Servers - PRIVSET.Read-Only - 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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.OperatingSystemFile.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Manage Servers - PRIVSET.Read-Only - READ.softwarerepository.OperatingSystemFile - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.OperatingSystemFile' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.OperatingSystemFile' resource is asynchronously being modified 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/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.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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.OperatingSystemFile' resource is asynchronously being patched 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/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.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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: post: tags: - softwarerepository summary: Create a 'softwarerepository.Release' resource. operationId: CreateSoftwarerepositoryRelease security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.softwarerepository.Release parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'softwarerepository.Release' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/softwarerepository.Release' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.Release' resource was created as requested. The 'softwarerepository.Release' 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.Release' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.Release' 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/softwarerepository.Release' 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' get: tags: - softwarerepository summary: Read a 'softwarerepository.Release' resource. operationId: GetSoftwarerepositoryReleaseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - 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: # Response as JSON document. schema: $ref: '#/components/schemas/softwarerepository.Release.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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 security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage Servers - PRIVSET.Read-Only - READ.softwarerepository.Release - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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' post: tags: - softwarerepository summary: Update a 'softwarerepository.Release' resource. operationId: UpdateSoftwarerepositoryRelease security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.Release parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.Release' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.Release' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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.Release' resource was modified as requested. The 'softwarerepository.Release' resource is modified before this response is sent back and the resource is returned in the body of the message. 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.Release' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.Release' resource is asynchronously being modified 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/softwarerepository.Release' 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' patch: tags: - softwarerepository summary: Update a 'softwarerepository.Release' resource. operationId: PatchSoftwarerepositoryRelease security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.softwarerepository.Release parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'softwarerepository.Release' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/softwarerepository.Release' application/json-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.Release' resource was patched as requested. The 'softwarerepository.Release' resource is patched before this response is sent back and the resource is returned in the body of the message. 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.Release' 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'softwarerepository.Release' resource is asynchronously being patched 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/softwarerepository.Release' 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' delete: tags: - softwarerepository summary: Delete a 'softwarerepository.Release' resource. operationId: DeleteSoftwarerepositoryRelease security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.softwarerepository.Release 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/sol/Policies: get: tags: - sol summary: Read a 'sol.Policy' resource. operationId: GetSolPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.sol.Policy - 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 'sol.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/sol.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sol summary: Create a 'sol.Policy' resource. operationId: CreateSolPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.sol.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'sol.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/sol.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sol.Policy' resource was created as requested. The 'sol.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sol.Policy' links: GetSolPolicyByMoid: operationId: GetSolPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'sol.Policy' 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/sol.Policy' links: GetSolPolicyByMoid: operationId: GetSolPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/sol/Policies/{Moid}: get: tags: - sol summary: Read a 'sol.Policy' resource. operationId: GetSolPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.sol.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'sol.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/sol.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSolPolicyByMoid: operationId: GetSolPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - sol summary: Update a 'sol.Policy' resource. operationId: UpdateSolPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.sol.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sol.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sol.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'sol.Policy' resource was modified as requested. The 'sol.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sol.Policy' links: GetSolPolicyByMoid: operationId: GetSolPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'sol.Policy' resource is asynchronously being modified 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/sol.Policy' links: GetSolPolicyByMoid: operationId: GetSolPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - sol summary: Update a 'sol.Policy' resource. operationId: PatchSolPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.sol.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'sol.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/sol.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 'sol.Policy' resource was patched as requested. The 'sol.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/sol.Policy' links: GetSolPolicyByMoid: operationId: GetSolPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'sol.Policy' resource is asynchronously being patched 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/sol.Policy' links: GetSolPolicyByMoid: operationId: GetSolPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - sol summary: Delete a 'sol.Policy' resource. operationId: DeleteSolPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.sol.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ssh/Policies: post: tags: - ssh summary: Create a 'ssh.Policy' resource. operationId: CreateSshPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.ssh.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'ssh.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/ssh.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was created as requested. The 'ssh.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ssh.Policy' links: GetSshPolicyByMoid: operationId: GetSshPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ssh.Policy' 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/ssh.Policy' links: GetSshPolicyByMoid: operationId: GetSshPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - ssh summary: Read a 'ssh.Policy' resource. operationId: GetSshPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.ssh.Policy - 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 'ssh.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ssh.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ssh/Policies/{Moid}: get: tags: - ssh summary: Read a 'ssh.Policy' resource. operationId: GetSshPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.ssh.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ssh.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ssh.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSshPolicyByMoid: operationId: GetSshPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - ssh summary: Update a 'ssh.Policy' resource. operationId: UpdateSshPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.ssh.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ssh.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ssh.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was modified as requested. The 'ssh.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ssh.Policy' links: GetSshPolicyByMoid: operationId: GetSshPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ssh.Policy' resource is asynchronously being modified 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/ssh.Policy' links: GetSshPolicyByMoid: operationId: GetSshPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - ssh summary: Update a 'ssh.Policy' resource. operationId: PatchSshPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.ssh.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'ssh.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/ssh.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 'ssh.Policy' resource was patched as requested. The 'ssh.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/ssh.Policy' links: GetSshPolicyByMoid: operationId: GetSshPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'ssh.Policy' resource is asynchronously being patched 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/ssh.Policy' links: GetSshPolicyByMoid: operationId: GetSshPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - ssh summary: Delete a 'ssh.Policy' resource. operationId: DeleteSshPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.ssh.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Controllers: get: tags: - storage summary: Read a 'storage.Controller' resource. operationId: GetStorageControllerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Controller - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.Controller' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.Controller.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Controllers/{Moid}: get: tags: - storage summary: Read a 'storage.Controller' resource. operationId: GetStorageControllerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Controller - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.Controller' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.Controller' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageControllerByMoid: operationId: GetStorageControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.Controller' resource. operationId: UpdateStorageController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.Controller parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.Controller' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.Controller' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Controller' resource was modified as requested. The 'storage.Controller' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.Controller' links: GetStorageControllerByMoid: operationId: GetStorageControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.Controller' resource is asynchronously being modified 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/storage.Controller' links: GetStorageControllerByMoid: operationId: GetStorageControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.Controller' resource. operationId: PatchStorageController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.Controller parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.Controller' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.Controller' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Controller' resource was patched as requested. The 'storage.Controller' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.Controller' links: GetStorageControllerByMoid: operationId: GetStorageControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.Controller' resource is asynchronously being patched 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/storage.Controller' links: GetStorageControllerByMoid: operationId: GetStorageControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/DiskGroups: get: tags: - storage summary: Read a 'storage.DiskGroup' resource. operationId: GetStorageDiskGroupList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.DiskGroup - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.DiskGroup' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.DiskGroup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/DiskGroups/{Moid}: get: tags: - storage summary: Read a 'storage.DiskGroup' resource. operationId: GetStorageDiskGroupByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.DiskGroup - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.DiskGroup' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroup' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageDiskGroupByMoid: operationId: GetStorageDiskGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.DiskGroup' resource. operationId: UpdateStorageDiskGroup security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.DiskGroup parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.DiskGroup' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.DiskGroup' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DiskGroup' resource was modified as requested. The 'storage.DiskGroup' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroup' links: GetStorageDiskGroupByMoid: operationId: GetStorageDiskGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.DiskGroup' resource is asynchronously being modified 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/storage.DiskGroup' links: GetStorageDiskGroupByMoid: operationId: GetStorageDiskGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.DiskGroup' resource. operationId: PatchStorageDiskGroup security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.DiskGroup parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.DiskGroup' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.DiskGroup' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DiskGroup' resource was patched as requested. The 'storage.DiskGroup' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroup' links: GetStorageDiskGroupByMoid: operationId: GetStorageDiskGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.DiskGroup' resource is asynchronously being patched 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/storage.DiskGroup' links: GetStorageDiskGroupByMoid: operationId: GetStorageDiskGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/DiskGroupPolicies: get: tags: - storage summary: Read a 'storage.DiskGroupPolicy' resource. operationId: GetStorageDiskGroupPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.storage.DiskGroupPolicy - 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 'storage.DiskGroupPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.DiskGroupPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Create a 'storage.DiskGroupPolicy' resource. operationId: CreateStorageDiskGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.storage.DiskGroupPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'storage.DiskGroupPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroupPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DiskGroupPolicy' resource was created as requested. The 'storage.DiskGroupPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroupPolicy' links: GetStorageDiskGroupPolicyByMoid: operationId: GetStorageDiskGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroupPolicies/{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 'storage.DiskGroupPolicy' 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/storage.DiskGroupPolicy' links: GetStorageDiskGroupPolicyByMoid: operationId: GetStorageDiskGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/DiskGroupPolicies/{Moid}: get: tags: - storage summary: Read a 'storage.DiskGroupPolicy' resource. operationId: GetStorageDiskGroupPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.storage.DiskGroupPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.DiskGroupPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroupPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageDiskGroupPolicyByMoid: operationId: GetStorageDiskGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.DiskGroupPolicy' resource. operationId: UpdateStorageDiskGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.storage.DiskGroupPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.DiskGroupPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.DiskGroupPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DiskGroupPolicy' resource was modified as requested. The 'storage.DiskGroupPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroupPolicy' links: GetStorageDiskGroupPolicyByMoid: operationId: GetStorageDiskGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroupPolicies/{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 'storage.DiskGroupPolicy' resource is asynchronously being modified 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/storage.DiskGroupPolicy' links: GetStorageDiskGroupPolicyByMoid: operationId: GetStorageDiskGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.DiskGroupPolicy' resource. operationId: PatchStorageDiskGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.storage.DiskGroupPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.DiskGroupPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.DiskGroupPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DiskGroupPolicy' resource was patched as requested. The 'storage.DiskGroupPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.DiskGroupPolicy' links: GetStorageDiskGroupPolicyByMoid: operationId: GetStorageDiskGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroupPolicies/{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 'storage.DiskGroupPolicy' resource is asynchronously being patched 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/storage.DiskGroupPolicy' links: GetStorageDiskGroupPolicyByMoid: operationId: GetStorageDiskGroupPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroupPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - storage summary: Delete a 'storage.DiskGroupPolicy' resource. operationId: DeleteStorageDiskGroupPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.storage.DiskGroupPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Enclosures: get: tags: - storage summary: Read a 'storage.Enclosure' resource. operationId: GetStorageEnclosureList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Enclosure - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.Enclosure' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.Enclosure.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Enclosures/{Moid}: get: tags: - storage summary: Read a 'storage.Enclosure' resource. operationId: GetStorageEnclosureByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Enclosure - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.Enclosure' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.Enclosure' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageEnclosureByMoid: operationId: GetStorageEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.Enclosure' resource. operationId: UpdateStorageEnclosure security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.Enclosure parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.Enclosure' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.Enclosure' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Enclosure' resource was modified as requested. The 'storage.Enclosure' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.Enclosure' links: GetStorageEnclosureByMoid: operationId: GetStorageEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.Enclosure' resource is asynchronously being modified 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/storage.Enclosure' links: GetStorageEnclosureByMoid: operationId: GetStorageEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.Enclosure' resource. operationId: PatchStorageEnclosure security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.Enclosure parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.Enclosure' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.Enclosure' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Enclosure' resource was patched as requested. The 'storage.Enclosure' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.Enclosure' links: GetStorageEnclosureByMoid: operationId: GetStorageEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.Enclosure' resource is asynchronously being patched 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/storage.Enclosure' links: GetStorageEnclosureByMoid: operationId: GetStorageEnclosureByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/EnclosureDisks: get: tags: - storage summary: Read a 'storage.EnclosureDisk' resource. operationId: GetStorageEnclosureDiskList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.EnclosureDisk - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.EnclosureDisk' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.EnclosureDisk.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/EnclosureDisks/{Moid}: get: tags: - storage summary: Read a 'storage.EnclosureDisk' resource. operationId: GetStorageEnclosureDiskByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.EnclosureDisk - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.EnclosureDisk' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.EnclosureDisk' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageEnclosureDiskByMoid: operationId: GetStorageEnclosureDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.EnclosureDisk' resource. operationId: UpdateStorageEnclosureDisk security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.EnclosureDisk parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.EnclosureDisk' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.EnclosureDisk' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDisk' resource was modified as requested. The 'storage.EnclosureDisk' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.EnclosureDisk' links: GetStorageEnclosureDiskByMoid: operationId: GetStorageEnclosureDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.EnclosureDisk' resource is asynchronously being modified 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/storage.EnclosureDisk' links: GetStorageEnclosureDiskByMoid: operationId: GetStorageEnclosureDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.EnclosureDisk' resource. operationId: PatchStorageEnclosureDisk security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.EnclosureDisk parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.EnclosureDisk' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.EnclosureDisk' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDisk' resource was patched as requested. The 'storage.EnclosureDisk' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.EnclosureDisk' links: GetStorageEnclosureDiskByMoid: operationId: GetStorageEnclosureDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.EnclosureDisk' resource is asynchronously being patched 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/storage.EnclosureDisk' links: GetStorageEnclosureDiskByMoid: operationId: GetStorageEnclosureDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/EnclosureDiskSlotEps: get: tags: - storage summary: Read a 'storage.EnclosureDiskSlotEp' resource. operationId: GetStorageEnclosureDiskSlotEpList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.EnclosureDiskSlotEp - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.EnclosureDiskSlotEp' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/EnclosureDiskSlotEps/{Moid}: get: tags: - storage summary: Read a 'storage.EnclosureDiskSlotEp' resource. operationId: GetStorageEnclosureDiskSlotEpByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.EnclosureDiskSlotEp - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.EnclosureDiskSlotEp' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageEnclosureDiskSlotEpByMoid: operationId: GetStorageEnclosureDiskSlotEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.EnclosureDiskSlotEp' resource. operationId: UpdateStorageEnclosureDiskSlotEp security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.EnclosureDiskSlotEp parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.EnclosureDiskSlotEp' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDiskSlotEp' resource was modified as requested. The 'storage.EnclosureDiskSlotEp' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp' links: GetStorageEnclosureDiskSlotEpByMoid: operationId: GetStorageEnclosureDiskSlotEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.EnclosureDiskSlotEp' resource is asynchronously being modified 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/storage.EnclosureDiskSlotEp' links: GetStorageEnclosureDiskSlotEpByMoid: operationId: GetStorageEnclosureDiskSlotEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.EnclosureDiskSlotEp' resource. operationId: PatchStorageEnclosureDiskSlotEp security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.EnclosureDiskSlotEp parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.EnclosureDiskSlotEp' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDiskSlotEp' resource was patched as requested. The 'storage.EnclosureDiskSlotEp' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp' links: GetStorageEnclosureDiskSlotEpByMoid: operationId: GetStorageEnclosureDiskSlotEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.EnclosureDiskSlotEp' resource is asynchronously being patched 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/storage.EnclosureDiskSlotEp' links: GetStorageEnclosureDiskSlotEpByMoid: operationId: GetStorageEnclosureDiskSlotEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashControllers: get: tags: - storage summary: Read a 'storage.FlexFlashController' resource. operationId: GetStorageFlexFlashControllerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashController - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.FlexFlashController' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.FlexFlashController.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashControllers/{Moid}: get: tags: - storage summary: Read a 'storage.FlexFlashController' resource. operationId: GetStorageFlexFlashControllerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashController - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.FlexFlashController' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashController' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageFlexFlashControllerByMoid: operationId: GetStorageFlexFlashControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.FlexFlashController' resource. operationId: UpdateStorageFlexFlashController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashController parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashController' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashController' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashController' resource was modified as requested. The 'storage.FlexFlashController' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashController' links: GetStorageFlexFlashControllerByMoid: operationId: GetStorageFlexFlashControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashController' resource is asynchronously being modified 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/storage.FlexFlashController' links: GetStorageFlexFlashControllerByMoid: operationId: GetStorageFlexFlashControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.FlexFlashController' resource. operationId: PatchStorageFlexFlashController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashController parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashController' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashController' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashController' resource was patched as requested. The 'storage.FlexFlashController' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashController' links: GetStorageFlexFlashControllerByMoid: operationId: GetStorageFlexFlashControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashController' resource is asynchronously being patched 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/storage.FlexFlashController' links: GetStorageFlexFlashControllerByMoid: operationId: GetStorageFlexFlashControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashControllerProps: get: tags: - storage summary: Read a 'storage.FlexFlashControllerProps' resource. operationId: GetStorageFlexFlashControllerPropsList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashControllerProps - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.FlexFlashControllerProps' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.FlexFlashControllerProps.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashControllerProps/{Moid}: get: tags: - storage summary: Read a 'storage.FlexFlashControllerProps' resource. operationId: GetStorageFlexFlashControllerPropsByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashControllerProps - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.FlexFlashControllerProps' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashControllerProps' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageFlexFlashControllerPropsByMoid: operationId: GetStorageFlexFlashControllerPropsByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.FlexFlashControllerProps' resource. operationId: UpdateStorageFlexFlashControllerProps security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashControllerProps parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashControllerProps' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashControllerProps' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashControllerProps' resource was modified as requested. The 'storage.FlexFlashControllerProps' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashControllerProps' links: GetStorageFlexFlashControllerPropsByMoid: operationId: GetStorageFlexFlashControllerPropsByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashControllerProps' resource is asynchronously being modified 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/storage.FlexFlashControllerProps' links: GetStorageFlexFlashControllerPropsByMoid: operationId: GetStorageFlexFlashControllerPropsByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.FlexFlashControllerProps' resource. operationId: PatchStorageFlexFlashControllerProps security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashControllerProps parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashControllerProps' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashControllerProps' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashControllerProps' resource was patched as requested. The 'storage.FlexFlashControllerProps' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashControllerProps' links: GetStorageFlexFlashControllerPropsByMoid: operationId: GetStorageFlexFlashControllerPropsByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashControllerProps' resource is asynchronously being patched 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/storage.FlexFlashControllerProps' links: GetStorageFlexFlashControllerPropsByMoid: operationId: GetStorageFlexFlashControllerPropsByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashPhysicalDrives: get: tags: - storage summary: Read a 'storage.FlexFlashPhysicalDrive' resource. operationId: GetStorageFlexFlashPhysicalDriveList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashPhysicalDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.FlexFlashPhysicalDrive' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashPhysicalDrives/{Moid}: get: tags: - storage summary: Read a 'storage.FlexFlashPhysicalDrive' resource. operationId: GetStorageFlexFlashPhysicalDriveByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashPhysicalDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.FlexFlashPhysicalDrive' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageFlexFlashPhysicalDriveByMoid: operationId: GetStorageFlexFlashPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.FlexFlashPhysicalDrive' resource. operationId: UpdateStorageFlexFlashPhysicalDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashPhysicalDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashPhysicalDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashPhysicalDrive' resource was modified as requested. The 'storage.FlexFlashPhysicalDrive' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive' links: GetStorageFlexFlashPhysicalDriveByMoid: operationId: GetStorageFlexFlashPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashPhysicalDrive' resource is asynchronously being modified 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/storage.FlexFlashPhysicalDrive' links: GetStorageFlexFlashPhysicalDriveByMoid: operationId: GetStorageFlexFlashPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.FlexFlashPhysicalDrive' resource. operationId: PatchStorageFlexFlashPhysicalDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashPhysicalDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashPhysicalDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashPhysicalDrive' resource was patched as requested. The 'storage.FlexFlashPhysicalDrive' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive' links: GetStorageFlexFlashPhysicalDriveByMoid: operationId: GetStorageFlexFlashPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashPhysicalDrive' resource is asynchronously being patched 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/storage.FlexFlashPhysicalDrive' links: GetStorageFlexFlashPhysicalDriveByMoid: operationId: GetStorageFlexFlashPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashVirtualDrives: get: tags: - storage summary: Read a 'storage.FlexFlashVirtualDrive' resource. operationId: GetStorageFlexFlashVirtualDriveList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashVirtualDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.FlexFlashVirtualDrive' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexFlashVirtualDrives/{Moid}: get: tags: - storage summary: Read a 'storage.FlexFlashVirtualDrive' resource. operationId: GetStorageFlexFlashVirtualDriveByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexFlashVirtualDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.FlexFlashVirtualDrive' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageFlexFlashVirtualDriveByMoid: operationId: GetStorageFlexFlashVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.FlexFlashVirtualDrive' resource. operationId: UpdateStorageFlexFlashVirtualDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashVirtualDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashVirtualDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashVirtualDrive' resource was modified as requested. The 'storage.FlexFlashVirtualDrive' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive' links: GetStorageFlexFlashVirtualDriveByMoid: operationId: GetStorageFlexFlashVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashVirtualDrive' resource is asynchronously being modified 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/storage.FlexFlashVirtualDrive' links: GetStorageFlexFlashVirtualDriveByMoid: operationId: GetStorageFlexFlashVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.FlexFlashVirtualDrive' resource. operationId: PatchStorageFlexFlashVirtualDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexFlashVirtualDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexFlashVirtualDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashVirtualDrive' resource was patched as requested. The 'storage.FlexFlashVirtualDrive' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive' links: GetStorageFlexFlashVirtualDriveByMoid: operationId: GetStorageFlexFlashVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexFlashVirtualDrive' resource is asynchronously being patched 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/storage.FlexFlashVirtualDrive' links: GetStorageFlexFlashVirtualDriveByMoid: operationId: GetStorageFlexFlashVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexUtilControllers: get: tags: - storage summary: Read a 'storage.FlexUtilController' resource. operationId: GetStorageFlexUtilControllerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexUtilController - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.FlexUtilController' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.FlexUtilController.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexUtilControllers/{Moid}: get: tags: - storage summary: Read a 'storage.FlexUtilController' resource. operationId: GetStorageFlexUtilControllerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexUtilController - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.FlexUtilController' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilController' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageFlexUtilControllerByMoid: operationId: GetStorageFlexUtilControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.FlexUtilController' resource. operationId: UpdateStorageFlexUtilController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexUtilController parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexUtilController' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexUtilController' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilController' resource was modified as requested. The 'storage.FlexUtilController' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilController' links: GetStorageFlexUtilControllerByMoid: operationId: GetStorageFlexUtilControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexUtilController' resource is asynchronously being modified 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/storage.FlexUtilController' links: GetStorageFlexUtilControllerByMoid: operationId: GetStorageFlexUtilControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.FlexUtilController' resource. operationId: PatchStorageFlexUtilController security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexUtilController parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexUtilController' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexUtilController' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilController' resource was patched as requested. The 'storage.FlexUtilController' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilController' links: GetStorageFlexUtilControllerByMoid: operationId: GetStorageFlexUtilControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexUtilController' resource is asynchronously being patched 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/storage.FlexUtilController' links: GetStorageFlexUtilControllerByMoid: operationId: GetStorageFlexUtilControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexUtilPhysicalDrives: get: tags: - storage summary: Read a 'storage.FlexUtilPhysicalDrive' resource. operationId: GetStorageFlexUtilPhysicalDriveList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexUtilPhysicalDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.FlexUtilPhysicalDrive' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexUtilPhysicalDrives/{Moid}: get: tags: - storage summary: Read a 'storage.FlexUtilPhysicalDrive' resource. operationId: GetStorageFlexUtilPhysicalDriveByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexUtilPhysicalDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.FlexUtilPhysicalDrive' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageFlexUtilPhysicalDriveByMoid: operationId: GetStorageFlexUtilPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.FlexUtilPhysicalDrive' resource. operationId: UpdateStorageFlexUtilPhysicalDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexUtilPhysicalDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexUtilPhysicalDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilPhysicalDrive' resource was modified as requested. The 'storage.FlexUtilPhysicalDrive' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive' links: GetStorageFlexUtilPhysicalDriveByMoid: operationId: GetStorageFlexUtilPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexUtilPhysicalDrive' resource is asynchronously being modified 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/storage.FlexUtilPhysicalDrive' links: GetStorageFlexUtilPhysicalDriveByMoid: operationId: GetStorageFlexUtilPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.FlexUtilPhysicalDrive' resource. operationId: PatchStorageFlexUtilPhysicalDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexUtilPhysicalDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexUtilPhysicalDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilPhysicalDrive' resource was patched as requested. The 'storage.FlexUtilPhysicalDrive' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive' links: GetStorageFlexUtilPhysicalDriveByMoid: operationId: GetStorageFlexUtilPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexUtilPhysicalDrive' resource is asynchronously being patched 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/storage.FlexUtilPhysicalDrive' links: GetStorageFlexUtilPhysicalDriveByMoid: operationId: GetStorageFlexUtilPhysicalDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexUtilVirtualDrives: get: tags: - storage summary: Read a 'storage.FlexUtilVirtualDrive' resource. operationId: GetStorageFlexUtilVirtualDriveList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexUtilVirtualDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.FlexUtilVirtualDrive' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/FlexUtilVirtualDrives/{Moid}: get: tags: - storage summary: Read a 'storage.FlexUtilVirtualDrive' resource. operationId: GetStorageFlexUtilVirtualDriveByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.FlexUtilVirtualDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.FlexUtilVirtualDrive' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageFlexUtilVirtualDriveByMoid: operationId: GetStorageFlexUtilVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.FlexUtilVirtualDrive' resource. operationId: UpdateStorageFlexUtilVirtualDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexUtilVirtualDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexUtilVirtualDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilVirtualDrive' resource was modified as requested. The 'storage.FlexUtilVirtualDrive' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive' links: GetStorageFlexUtilVirtualDriveByMoid: operationId: GetStorageFlexUtilVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexUtilVirtualDrive' resource is asynchronously being modified 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/storage.FlexUtilVirtualDrive' links: GetStorageFlexUtilVirtualDriveByMoid: operationId: GetStorageFlexUtilVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.FlexUtilVirtualDrive' resource. operationId: PatchStorageFlexUtilVirtualDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.FlexUtilVirtualDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.FlexUtilVirtualDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilVirtualDrive' resource was patched as requested. The 'storage.FlexUtilVirtualDrive' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive' links: GetStorageFlexUtilVirtualDriveByMoid: operationId: GetStorageFlexUtilVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.FlexUtilVirtualDrive' resource is asynchronously being patched 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/storage.FlexUtilVirtualDrive' links: GetStorageFlexUtilVirtualDriveByMoid: operationId: GetStorageFlexUtilVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Items: get: tags: - storage summary: Read a 'storage.Item' resource. operationId: GetStorageItemList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Item - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.Item' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.Item.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Items/{Moid}: get: tags: - storage summary: Read a 'storage.Item' resource. operationId: GetStorageItemByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Item - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.Item' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.Item' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageItemByMoid: operationId: GetStorageItemByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Items/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PhysicalDisks: get: tags: - storage summary: Read a 'storage.PhysicalDisk' resource. operationId: GetStoragePhysicalDiskList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.PhysicalDisk - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.PhysicalDisk' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PhysicalDisk.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PhysicalDisks/{Moid}: get: tags: - storage summary: Read a 'storage.PhysicalDisk' resource. operationId: GetStoragePhysicalDiskByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.PhysicalDisk - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PhysicalDisk' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDisk' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePhysicalDiskByMoid: operationId: GetStoragePhysicalDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.PhysicalDisk' resource. operationId: UpdateStoragePhysicalDisk security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.PhysicalDisk parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PhysicalDisk' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PhysicalDisk' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDisk' resource was modified as requested. The 'storage.PhysicalDisk' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDisk' links: GetStoragePhysicalDiskByMoid: operationId: GetStoragePhysicalDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PhysicalDisk' resource is asynchronously being modified 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/storage.PhysicalDisk' links: GetStoragePhysicalDiskByMoid: operationId: GetStoragePhysicalDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.PhysicalDisk' resource. operationId: PatchStoragePhysicalDisk security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.PhysicalDisk parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PhysicalDisk' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PhysicalDisk' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDisk' resource was patched as requested. The 'storage.PhysicalDisk' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDisk' links: GetStoragePhysicalDiskByMoid: operationId: GetStoragePhysicalDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PhysicalDisk' resource is asynchronously being patched 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/storage.PhysicalDisk' links: GetStoragePhysicalDiskByMoid: operationId: GetStoragePhysicalDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PhysicalDiskExtensions: get: tags: - storage summary: Read a 'storage.PhysicalDiskExtension' resource. operationId: GetStoragePhysicalDiskExtensionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.PhysicalDiskExtension - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.PhysicalDiskExtension' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PhysicalDiskExtension.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PhysicalDiskExtensions/{Moid}: get: tags: - storage summary: Read a 'storage.PhysicalDiskExtension' resource. operationId: GetStoragePhysicalDiskExtensionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.PhysicalDiskExtension - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PhysicalDiskExtension' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskExtension' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePhysicalDiskExtensionByMoid: operationId: GetStoragePhysicalDiskExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.PhysicalDiskExtension' resource. operationId: UpdateStoragePhysicalDiskExtension security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.PhysicalDiskExtension parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PhysicalDiskExtension' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskExtension' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskExtension' resource was modified as requested. The 'storage.PhysicalDiskExtension' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskExtension' links: GetStoragePhysicalDiskExtensionByMoid: operationId: GetStoragePhysicalDiskExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PhysicalDiskExtension' resource is asynchronously being modified 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/storage.PhysicalDiskExtension' links: GetStoragePhysicalDiskExtensionByMoid: operationId: GetStoragePhysicalDiskExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.PhysicalDiskExtension' resource. operationId: PatchStoragePhysicalDiskExtension security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.PhysicalDiskExtension parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PhysicalDiskExtension' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskExtension' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskExtension' resource was patched as requested. The 'storage.PhysicalDiskExtension' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskExtension' links: GetStoragePhysicalDiskExtensionByMoid: operationId: GetStoragePhysicalDiskExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PhysicalDiskExtension' resource is asynchronously being patched 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/storage.PhysicalDiskExtension' links: GetStoragePhysicalDiskExtensionByMoid: operationId: GetStoragePhysicalDiskExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PhysicalDiskUsages: get: tags: - storage summary: Read a 'storage.PhysicalDiskUsage' resource. operationId: GetStoragePhysicalDiskUsageList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.PhysicalDiskUsage - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.PhysicalDiskUsage' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PhysicalDiskUsage.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PhysicalDiskUsages/{Moid}: get: tags: - storage summary: Read a 'storage.PhysicalDiskUsage' resource. operationId: GetStoragePhysicalDiskUsageByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.PhysicalDiskUsage - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PhysicalDiskUsage' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskUsage' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePhysicalDiskUsageByMoid: operationId: GetStoragePhysicalDiskUsageByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.PhysicalDiskUsage' resource. operationId: UpdateStoragePhysicalDiskUsage security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.PhysicalDiskUsage parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PhysicalDiskUsage' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskUsage' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskUsage' resource was modified as requested. The 'storage.PhysicalDiskUsage' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskUsage' links: GetStoragePhysicalDiskUsageByMoid: operationId: GetStoragePhysicalDiskUsageByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PhysicalDiskUsage' resource is asynchronously being modified 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/storage.PhysicalDiskUsage' links: GetStoragePhysicalDiskUsageByMoid: operationId: GetStoragePhysicalDiskUsageByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.PhysicalDiskUsage' resource. operationId: PatchStoragePhysicalDiskUsage security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.PhysicalDiskUsage parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PhysicalDiskUsage' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskUsage' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskUsage' resource was patched as requested. The 'storage.PhysicalDiskUsage' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PhysicalDiskUsage' links: GetStoragePhysicalDiskUsageByMoid: operationId: GetStoragePhysicalDiskUsageByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PhysicalDiskUsage' resource is asynchronously being patched 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/storage.PhysicalDiskUsage' links: GetStoragePhysicalDiskUsageByMoid: operationId: GetStoragePhysicalDiskUsageByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureArrays: get: tags: - storage summary: Read a 'storage.PureArray' resource. operationId: GetStoragePureArrayList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureArray - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureArray' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureArray.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureArrays/{Moid}: get: tags: - storage summary: Read a 'storage.PureArray' resource. operationId: GetStoragePureArrayByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureArray - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureArray' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureArray' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureArrayByMoid: operationId: GetStoragePureArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.PureArray' resource. operationId: UpdateStoragePureArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - ROLE.Account Administrator - UPDATE.storage.PureArray parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PureArray' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PureArray' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PureArray' resource was modified as requested. The 'storage.PureArray' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PureArray' links: GetStoragePureArrayByMoid: operationId: GetStoragePureArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PureArray' resource is asynchronously being modified 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/storage.PureArray' links: GetStoragePureArrayByMoid: operationId: GetStoragePureArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.PureArray' resource. operationId: PatchStoragePureArray security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - ROLE.Account Administrator - UPDATE.storage.PureArray parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.PureArray' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.PureArray' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PureArray' resource was patched as requested. The 'storage.PureArray' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.PureArray' links: GetStoragePureArrayByMoid: operationId: GetStoragePureArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.PureArray' resource is asynchronously being patched 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/storage.PureArray' links: GetStoragePureArrayByMoid: operationId: GetStoragePureArrayByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureControllers: get: tags: - storage summary: Read a 'storage.PureController' resource. operationId: GetStoragePureControllerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureController - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureController' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureController.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureControllers/{Moid}: get: tags: - storage summary: Read a 'storage.PureController' resource. operationId: GetStoragePureControllerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureController - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureController' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureController' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureControllerByMoid: operationId: GetStoragePureControllerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureControllers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureDisks: get: tags: - storage summary: Read a 'storage.PureDisk' resource. operationId: GetStoragePureDiskList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureDisk - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureDisk' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureDisk.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureDisks/{Moid}: get: tags: - storage summary: Read a 'storage.PureDisk' resource. operationId: GetStoragePureDiskByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureDisk - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureDisk' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureDisk' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureDiskByMoid: operationId: GetStoragePureDiskByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureDisks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureHosts: get: tags: - storage summary: Read a 'storage.PureHost' resource. operationId: GetStoragePureHostList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureHost - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureHost' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureHost.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureHosts/{Moid}: get: tags: - storage summary: Read a 'storage.PureHost' resource. operationId: GetStoragePureHostByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureHost - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureHost' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureHost' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureHostByMoid: operationId: GetStoragePureHostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureHosts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureHostGroups: get: tags: - storage summary: Read a 'storage.PureHostGroup' resource. operationId: GetStoragePureHostGroupList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureHostGroup - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureHostGroup' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureHostGroup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureHostGroups/{Moid}: get: tags: - storage summary: Read a 'storage.PureHostGroup' resource. operationId: GetStoragePureHostGroupByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureHostGroup - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureHostGroup' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureHostGroup' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureHostGroupByMoid: operationId: GetStoragePureHostGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureHostGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureHostLuns: get: tags: - storage summary: Read a 'storage.PureHostLun' resource. operationId: GetStoragePureHostLunList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureHostLun - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureHostLun' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureHostLun.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureHostLuns/{Moid}: get: tags: - storage summary: Read a 'storage.PureHostLun' resource. operationId: GetStoragePureHostLunByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureHostLun - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureHostLun' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureHostLun' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureHostLunByMoid: operationId: GetStoragePureHostLunByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureHostLuns/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PurePorts: get: tags: - storage summary: Read a 'storage.PurePort' resource. operationId: GetStoragePurePortList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PurePort - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PurePort' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PurePort.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PurePorts/{Moid}: get: tags: - storage summary: Read a 'storage.PurePort' resource. operationId: GetStoragePurePortByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PurePort - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PurePort' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PurePort' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePurePortByMoid: operationId: GetStoragePurePortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PurePorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureProtectionGroups: get: tags: - storage summary: Read a 'storage.PureProtectionGroup' resource. operationId: GetStoragePureProtectionGroupList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureProtectionGroup - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureProtectionGroup' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureProtectionGroup.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureProtectionGroups/{Moid}: get: tags: - storage summary: Read a 'storage.PureProtectionGroup' resource. operationId: GetStoragePureProtectionGroupByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureProtectionGroup - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureProtectionGroup' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureProtectionGroup' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureProtectionGroupByMoid: operationId: GetStoragePureProtectionGroupByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureProtectionGroups/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureProtectionGroupSnapshots: get: tags: - storage summary: Read a 'storage.PureProtectionGroupSnapshot' resource. operationId: GetStoragePureProtectionGroupSnapshotList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureProtectionGroupSnapshot - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureProtectionGroupSnapshot' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureProtectionGroupSnapshot.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureProtectionGroupSnapshots/{Moid}: get: tags: - storage summary: Read a 'storage.PureProtectionGroupSnapshot' resource. operationId: GetStoragePureProtectionGroupSnapshotByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureProtectionGroupSnapshot - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureProtectionGroupSnapshot' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureProtectionGroupSnapshot' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureProtectionGroupSnapshotByMoid: operationId: GetStoragePureProtectionGroupSnapshotByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureProtectionGroupSnapshots/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureReplicationSchedules: get: tags: - storage summary: Read a 'storage.PureReplicationSchedule' resource. operationId: GetStoragePureReplicationScheduleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureReplicationSchedule - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureReplicationSchedule' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureReplicationSchedule.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureReplicationSchedules/{Moid}: get: tags: - storage summary: Read a 'storage.PureReplicationSchedule' resource. operationId: GetStoragePureReplicationScheduleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureReplicationSchedule - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureReplicationSchedule' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureReplicationSchedule' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureReplicationScheduleByMoid: operationId: GetStoragePureReplicationScheduleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureReplicationSchedules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureSnapshotSchedules: get: tags: - storage summary: Read a 'storage.PureSnapshotSchedule' resource. operationId: GetStoragePureSnapshotScheduleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureSnapshotSchedule - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureSnapshotSchedule' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureSnapshotSchedule.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureSnapshotSchedules/{Moid}: get: tags: - storage summary: Read a 'storage.PureSnapshotSchedule' resource. operationId: GetStoragePureSnapshotScheduleByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureSnapshotSchedule - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureSnapshotSchedule' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureSnapshotSchedule' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureSnapshotScheduleByMoid: operationId: GetStoragePureSnapshotScheduleByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureSnapshotSchedules/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureVolumes: get: tags: - storage summary: Read a 'storage.PureVolume' resource. operationId: GetStoragePureVolumeList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureVolume - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureVolume' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureVolume.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureVolumes/{Moid}: get: tags: - storage summary: Read a 'storage.PureVolume' resource. operationId: GetStoragePureVolumeByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureVolume - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureVolume' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureVolume' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureVolumeByMoid: operationId: GetStoragePureVolumeByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureVolumes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureVolumeSnapshots: get: tags: - storage summary: Read a 'storage.PureVolumeSnapshot' resource. operationId: GetStoragePureVolumeSnapshotList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureVolumeSnapshot - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'storage.PureVolumeSnapshot' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.PureVolumeSnapshot.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/PureVolumeSnapshots/{Moid}: get: tags: - storage summary: Read a 'storage.PureVolumeSnapshot' resource. operationId: GetStoragePureVolumeSnapshotByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Storage Arrays - PRIVSET.Read-Only - PRIVSET.View Storage Arrays - READ.storage.PureVolumeSnapshot - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.PureVolumeSnapshot' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.PureVolumeSnapshot' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStoragePureVolumeSnapshotByMoid: operationId: GetStoragePureVolumeSnapshotByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureVolumeSnapshots/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/SasExpanders: get: tags: - storage summary: Read a 'storage.SasExpander' resource. operationId: GetStorageSasExpanderList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.SasExpander - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.SasExpander' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.SasExpander.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/SasExpanders/{Moid}: get: tags: - storage summary: Read a 'storage.SasExpander' resource. operationId: GetStorageSasExpanderByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.SasExpander - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.SasExpander' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.SasExpander' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageSasExpanderByMoid: operationId: GetStorageSasExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.SasExpander' resource. operationId: UpdateStorageSasExpander security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.SasExpander parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.SasExpander' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.SasExpander' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasExpander' resource was modified as requested. The 'storage.SasExpander' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.SasExpander' links: GetStorageSasExpanderByMoid: operationId: GetStorageSasExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.SasExpander' resource is asynchronously being modified 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/storage.SasExpander' links: GetStorageSasExpanderByMoid: operationId: GetStorageSasExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.SasExpander' resource. operationId: PatchStorageSasExpander security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.SasExpander parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.SasExpander' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.SasExpander' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasExpander' resource was patched as requested. The 'storage.SasExpander' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.SasExpander' links: GetStorageSasExpanderByMoid: operationId: GetStorageSasExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.SasExpander' resource is asynchronously being patched 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/storage.SasExpander' links: GetStorageSasExpanderByMoid: operationId: GetStorageSasExpanderByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/SasPorts: get: tags: - storage summary: Read a 'storage.SasPort' resource. operationId: GetStorageSasPortList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.SasPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.SasPort' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.SasPort.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/SasPorts/{Moid}: get: tags: - storage summary: Read a 'storage.SasPort' resource. operationId: GetStorageSasPortByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.SasPort - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.SasPort' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.SasPort' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageSasPortByMoid: operationId: GetStorageSasPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.SasPort' resource. operationId: UpdateStorageSasPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.SasPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.SasPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.SasPort' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasPort' resource was modified as requested. The 'storage.SasPort' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.SasPort' links: GetStorageSasPortByMoid: operationId: GetStorageSasPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.SasPort' resource is asynchronously being modified 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/storage.SasPort' links: GetStorageSasPortByMoid: operationId: GetStorageSasPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.SasPort' resource. operationId: PatchStorageSasPort security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.SasPort parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.SasPort' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.SasPort' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasPort' resource was patched as requested. The 'storage.SasPort' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.SasPort' links: GetStorageSasPortByMoid: operationId: GetStorageSasPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.SasPort' resource is asynchronously being patched 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/storage.SasPort' links: GetStorageSasPortByMoid: operationId: GetStorageSasPortByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Spans: get: tags: - storage summary: Read a 'storage.Span' resource. operationId: GetStorageSpanList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Span - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.Span' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.Span.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/Spans/{Moid}: get: tags: - storage summary: Read a 'storage.Span' resource. operationId: GetStorageSpanByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.Span - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.Span' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.Span' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageSpanByMoid: operationId: GetStorageSpanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.Span' resource. operationId: UpdateStorageSpan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.Span parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.Span' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.Span' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Span' resource was modified as requested. The 'storage.Span' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.Span' links: GetStorageSpanByMoid: operationId: GetStorageSpanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.Span' resource is asynchronously being modified 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/storage.Span' links: GetStorageSpanByMoid: operationId: GetStorageSpanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.Span' resource. operationId: PatchStorageSpan security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.Span parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.Span' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.Span' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Span' resource was patched as requested. The 'storage.Span' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.Span' links: GetStorageSpanByMoid: operationId: GetStorageSpanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.Span' resource is asynchronously being patched 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/storage.Span' links: GetStorageSpanByMoid: operationId: GetStorageSpanByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/StoragePolicies: get: tags: - storage summary: Read a 'storage.StoragePolicy' resource. operationId: GetStorageStoragePolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.storage.StoragePolicy - 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 'storage.StoragePolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.StoragePolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Create a 'storage.StoragePolicy' resource. operationId: CreateStorageStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.storage.StoragePolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'storage.StoragePolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/storage.StoragePolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.StoragePolicy' resource was created as requested. The 'storage.StoragePolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.StoragePolicy' links: GetStorageStoragePolicyByMoid: operationId: GetStorageStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.StoragePolicy' 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/storage.StoragePolicy' links: GetStorageStoragePolicyByMoid: operationId: GetStorageStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/StoragePolicies/{Moid}: get: tags: - storage summary: Read a 'storage.StoragePolicy' resource. operationId: GetStorageStoragePolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.storage.StoragePolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.StoragePolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.StoragePolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageStoragePolicyByMoid: operationId: GetStorageStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.StoragePolicy' resource. operationId: UpdateStorageStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.storage.StoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.StoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.StoragePolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.StoragePolicy' resource was modified as requested. The 'storage.StoragePolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.StoragePolicy' links: GetStorageStoragePolicyByMoid: operationId: GetStorageStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.StoragePolicy' resource is asynchronously being modified 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/storage.StoragePolicy' links: GetStorageStoragePolicyByMoid: operationId: GetStorageStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.StoragePolicy' resource. operationId: PatchStorageStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.storage.StoragePolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.StoragePolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.StoragePolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.StoragePolicy' resource was patched as requested. The 'storage.StoragePolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.StoragePolicy' links: GetStorageStoragePolicyByMoid: operationId: GetStorageStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.StoragePolicy' resource is asynchronously being patched 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/storage.StoragePolicy' links: GetStorageStoragePolicyByMoid: operationId: GetStorageStoragePolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - storage summary: Delete a 'storage.StoragePolicy' resource. operationId: DeleteStorageStoragePolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.storage.StoragePolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/VdMemberEps: get: tags: - storage summary: Read a 'storage.VdMemberEp' resource. operationId: GetStorageVdMemberEpList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.VdMemberEp - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.VdMemberEp' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.VdMemberEp.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/VdMemberEps/{Moid}: get: tags: - storage summary: Read a 'storage.VdMemberEp' resource. operationId: GetStorageVdMemberEpByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.VdMemberEp - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.VdMemberEp' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.VdMemberEp' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageVdMemberEpByMoid: operationId: GetStorageVdMemberEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.VdMemberEp' resource. operationId: UpdateStorageVdMemberEp security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.VdMemberEp parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.VdMemberEp' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.VdMemberEp' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VdMemberEp' resource was modified as requested. The 'storage.VdMemberEp' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.VdMemberEp' links: GetStorageVdMemberEpByMoid: operationId: GetStorageVdMemberEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.VdMemberEp' resource is asynchronously being modified 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/storage.VdMemberEp' links: GetStorageVdMemberEpByMoid: operationId: GetStorageVdMemberEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.VdMemberEp' resource. operationId: PatchStorageVdMemberEp security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.VdMemberEp parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.VdMemberEp' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.VdMemberEp' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VdMemberEp' resource was patched as requested. The 'storage.VdMemberEp' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.VdMemberEp' links: GetStorageVdMemberEpByMoid: operationId: GetStorageVdMemberEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.VdMemberEp' resource is asynchronously being patched 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/storage.VdMemberEp' links: GetStorageVdMemberEpByMoid: operationId: GetStorageVdMemberEpByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/VirtualDrives: get: tags: - storage summary: Read a 'storage.VirtualDrive' resource. operationId: GetStorageVirtualDriveList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.VirtualDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.VirtualDrive' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.VirtualDrive.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/VirtualDrives/{Moid}: get: tags: - storage summary: Read a 'storage.VirtualDrive' resource. operationId: GetStorageVirtualDriveByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.VirtualDrive - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.VirtualDrive' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.VirtualDrive' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageVirtualDriveByMoid: operationId: GetStorageVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.VirtualDrive' resource. operationId: UpdateStorageVirtualDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.VirtualDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.VirtualDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.VirtualDrive' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDrive' resource was modified as requested. The 'storage.VirtualDrive' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.VirtualDrive' links: GetStorageVirtualDriveByMoid: operationId: GetStorageVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.VirtualDrive' resource is asynchronously being modified 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/storage.VirtualDrive' links: GetStorageVirtualDriveByMoid: operationId: GetStorageVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.VirtualDrive' resource. operationId: PatchStorageVirtualDrive security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.VirtualDrive parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.VirtualDrive' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.VirtualDrive' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDrive' resource was patched as requested. The 'storage.VirtualDrive' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.VirtualDrive' links: GetStorageVirtualDriveByMoid: operationId: GetStorageVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.VirtualDrive' resource is asynchronously being patched 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/storage.VirtualDrive' links: GetStorageVirtualDriveByMoid: operationId: GetStorageVirtualDriveByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/VirtualDriveExtensions: get: tags: - storage summary: Read a 'storage.VirtualDriveExtension' resource. operationId: GetStorageVirtualDriveExtensionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.VirtualDriveExtension - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'storage.VirtualDriveExtension' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/storage.VirtualDriveExtension.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/storage/VirtualDriveExtensions/{Moid}: get: tags: - storage summary: Read a 'storage.VirtualDriveExtension' resource. operationId: GetStorageVirtualDriveExtensionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.View Servers - READ.storage.VirtualDriveExtension - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'storage.VirtualDriveExtension' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/storage.VirtualDriveExtension' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetStorageVirtualDriveExtensionByMoid: operationId: GetStorageVirtualDriveExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - storage summary: Update a 'storage.VirtualDriveExtension' resource. operationId: UpdateStorageVirtualDriveExtension security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.VirtualDriveExtension parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.VirtualDriveExtension' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.VirtualDriveExtension' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDriveExtension' resource was modified as requested. The 'storage.VirtualDriveExtension' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.VirtualDriveExtension' links: GetStorageVirtualDriveExtensionByMoid: operationId: GetStorageVirtualDriveExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.VirtualDriveExtension' resource is asynchronously being modified 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/storage.VirtualDriveExtension' links: GetStorageVirtualDriveExtensionByMoid: operationId: GetStorageVirtualDriveExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - storage summary: Update a 'storage.VirtualDriveExtension' resource. operationId: PatchStorageVirtualDriveExtension security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Servers - ROLE.Account Administrator - UPDATE.storage.VirtualDriveExtension parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'storage.VirtualDriveExtension' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/storage.VirtualDriveExtension' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDriveExtension' resource was patched as requested. The 'storage.VirtualDriveExtension' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/storage.VirtualDriveExtension' links: GetStorageVirtualDriveExtensionByMoid: operationId: GetStorageVirtualDriveExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'storage.VirtualDriveExtension' resource is asynchronously being patched 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/storage.VirtualDriveExtension' links: GetStorageVirtualDriveExtensionByMoid: operationId: GetStorageVirtualDriveExtensionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/syslog/Policies: post: tags: - syslog summary: Create a 'syslog.Policy' resource. operationId: CreateSyslogPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.syslog.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'syslog.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/syslog.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'syslog.Policy' resource was created as requested. The 'syslog.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/syslog.Policy' links: GetSyslogPolicyByMoid: operationId: GetSyslogPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'syslog.Policy' 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/syslog.Policy' links: GetSyslogPolicyByMoid: operationId: GetSyslogPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - syslog summary: Read a 'syslog.Policy' resource. operationId: GetSyslogPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.syslog.Policy - 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 'syslog.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/syslog.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/syslog/Policies/{Moid}: get: tags: - syslog summary: Read a 'syslog.Policy' resource. operationId: GetSyslogPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.syslog.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'syslog.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/syslog.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetSyslogPolicyByMoid: operationId: GetSyslogPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - syslog summary: Update a 'syslog.Policy' resource. operationId: UpdateSyslogPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.syslog.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'syslog.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/syslog.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'syslog.Policy' resource was modified as requested. The 'syslog.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/syslog.Policy' links: GetSyslogPolicyByMoid: operationId: GetSyslogPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'syslog.Policy' resource is asynchronously being modified 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/syslog.Policy' links: GetSyslogPolicyByMoid: operationId: GetSyslogPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - syslog summary: Update a 'syslog.Policy' resource. operationId: PatchSyslogPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.syslog.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'syslog.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/syslog.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 'syslog.Policy' resource was patched as requested. The 'syslog.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/syslog.Policy' links: GetSyslogPolicyByMoid: operationId: GetSyslogPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'syslog.Policy' resource is asynchronously being patched 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/syslog.Policy' links: GetSyslogPolicyByMoid: operationId: GetSyslogPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - syslog summary: Delete a 'syslog.Policy' resource. operationId: DeleteSyslogPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.syslog.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryCounts: get: tags: - tam summary: Read a 'tam.AdvisoryCount' resource. operationId: GetTamAdvisoryCountList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Devices - READ.tam.AdvisoryCount - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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 'tam.AdvisoryCount' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/tam.AdvisoryCount.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Create a 'tam.AdvisoryCount' resource. operationId: CreateTamAdvisoryCount security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.tam.AdvisoryCount parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'tam.AdvisoryCount' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryCount' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryCount' resource was created as requested. The 'tam.AdvisoryCount' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryCount' links: GetTamAdvisoryCountByMoid: operationId: GetTamAdvisoryCountByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryCount' 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/tam.AdvisoryCount' links: GetTamAdvisoryCountByMoid: operationId: GetTamAdvisoryCountByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryCounts/{Moid}: get: tags: - tam summary: Read a 'tam.AdvisoryCount' resource. operationId: GetTamAdvisoryCountByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Devices - READ.tam.AdvisoryCount - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'tam.AdvisoryCount' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryCount' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetTamAdvisoryCountByMoid: operationId: GetTamAdvisoryCountByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Update a 'tam.AdvisoryCount' resource. operationId: UpdateTamAdvisoryCount security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.AdvisoryCount parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryCount' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryCount' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryCount' resource was modified as requested. The 'tam.AdvisoryCount' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryCount' links: GetTamAdvisoryCountByMoid: operationId: GetTamAdvisoryCountByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryCount' resource is asynchronously being modified 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/tam.AdvisoryCount' links: GetTamAdvisoryCountByMoid: operationId: GetTamAdvisoryCountByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - tam summary: Update a 'tam.AdvisoryCount' resource. operationId: PatchTamAdvisoryCount security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.AdvisoryCount parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryCount' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryCount' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryCount' resource was patched as requested. The 'tam.AdvisoryCount' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryCount' links: GetTamAdvisoryCountByMoid: operationId: GetTamAdvisoryCountByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryCount' resource is asynchronously being patched 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/tam.AdvisoryCount' links: GetTamAdvisoryCountByMoid: operationId: GetTamAdvisoryCountByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - tam summary: Delete a 'tam.AdvisoryCount' resource. operationId: DeleteTamAdvisoryCount security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.tam.AdvisoryCount 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryDefinitions: get: tags: - tam summary: Read a 'tam.AdvisoryDefinition' resource. operationId: GetTamAdvisoryDefinitionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.HyperFlex Cluster - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.Server Administrator - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.tam.AdvisoryDefinition - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'tam.AdvisoryDefinition' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/tam.AdvisoryDefinition.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Create a 'tam.AdvisoryDefinition' resource. operationId: CreateTamAdvisoryDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.tam.AdvisoryDefinition parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'tam.AdvisoryDefinition' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryDefinition' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryDefinition' resource was created as requested. The 'tam.AdvisoryDefinition' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryDefinition' links: GetTamAdvisoryDefinitionByMoid: operationId: GetTamAdvisoryDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryDefinition' 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/tam.AdvisoryDefinition' links: GetTamAdvisoryDefinitionByMoid: operationId: GetTamAdvisoryDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryDefinitions/{Moid}: get: tags: - tam summary: Read a 'tam.AdvisoryDefinition' resource. operationId: GetTamAdvisoryDefinitionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.HyperFlex Cluster - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.Server Administrator - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.tam.AdvisoryDefinition - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'tam.AdvisoryDefinition' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryDefinition' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetTamAdvisoryDefinitionByMoid: operationId: GetTamAdvisoryDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Update a 'tam.AdvisoryDefinition' resource. operationId: UpdateTamAdvisoryDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.AdvisoryDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryDefinition' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryDefinition' resource was modified as requested. The 'tam.AdvisoryDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryDefinition' links: GetTamAdvisoryDefinitionByMoid: operationId: GetTamAdvisoryDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryDefinition' resource is asynchronously being modified 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/tam.AdvisoryDefinition' links: GetTamAdvisoryDefinitionByMoid: operationId: GetTamAdvisoryDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - tam summary: Update a 'tam.AdvisoryDefinition' resource. operationId: PatchTamAdvisoryDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.AdvisoryDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryDefinition' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryDefinition' resource was patched as requested. The 'tam.AdvisoryDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryDefinition' links: GetTamAdvisoryDefinitionByMoid: operationId: GetTamAdvisoryDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryDefinition' resource is asynchronously being patched 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/tam.AdvisoryDefinition' links: GetTamAdvisoryDefinitionByMoid: operationId: GetTamAdvisoryDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - tam summary: Delete a 'tam.AdvisoryDefinition' resource. operationId: DeleteTamAdvisoryDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.tam.AdvisoryDefinition 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryInfos: get: tags: - tam summary: Read a 'tam.AdvisoryInfo' resource. operationId: GetTamAdvisoryInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Devices - READ.tam.AdvisoryInfo - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization 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 'tam.AdvisoryInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/tam.AdvisoryInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Create a 'tam.AdvisoryInfo' resource. operationId: CreateTamAdvisoryInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.tam.AdvisoryInfo - PRIVSET.Account Administrator - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'tam.AdvisoryInfo' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInfo' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInfo' resource was created as requested. The 'tam.AdvisoryInfo' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInfo' links: GetTamAdvisoryInfoByMoid: operationId: GetTamAdvisoryInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryInfo' 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/tam.AdvisoryInfo' links: GetTamAdvisoryInfoByMoid: operationId: GetTamAdvisoryInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryInfos/{Moid}: get: tags: - tam summary: Read a 'tam.AdvisoryInfo' resource. operationId: GetTamAdvisoryInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - PRIVSET.View Devices - READ.tam.AdvisoryInfo - ROLE.Account Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.Virtualization Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'tam.AdvisoryInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetTamAdvisoryInfoByMoid: operationId: GetTamAdvisoryInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Update a 'tam.AdvisoryInfo' resource. operationId: UpdateTamAdvisoryInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.tam.AdvisoryInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInfo' resource was modified as requested. The 'tam.AdvisoryInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInfo' links: GetTamAdvisoryInfoByMoid: operationId: GetTamAdvisoryInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryInfo' resource is asynchronously being modified 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/tam.AdvisoryInfo' links: GetTamAdvisoryInfoByMoid: operationId: GetTamAdvisoryInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - tam summary: Update a 'tam.AdvisoryInfo' resource. operationId: PatchTamAdvisoryInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - ROLE.Account Administrator - UPDATE.tam.AdvisoryInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInfo' resource was patched as requested. The 'tam.AdvisoryInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInfo' links: GetTamAdvisoryInfoByMoid: operationId: GetTamAdvisoryInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryInfo' resource is asynchronously being patched 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/tam.AdvisoryInfo' links: GetTamAdvisoryInfoByMoid: operationId: GetTamAdvisoryInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - tam summary: Delete a 'tam.AdvisoryInfo' resource. operationId: DeleteTamAdvisoryInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.tam.AdvisoryInfo - PRIVSET.Account Administrator - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryInstances: get: tags: - tam summary: Read a 'tam.AdvisoryInstance' resource. operationId: GetTamAdvisoryInstanceList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.HyperFlex Cluster - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.Server Administrator - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.tam.AdvisoryInstance - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'tam.AdvisoryInstance' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/tam.AdvisoryInstance.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Create a 'tam.AdvisoryInstance' resource. operationId: CreateTamAdvisoryInstance security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.tam.AdvisoryInstance parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'tam.AdvisoryInstance' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInstance' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInstance' resource was created as requested. The 'tam.AdvisoryInstance' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInstance' links: GetTamAdvisoryInstanceByMoid: operationId: GetTamAdvisoryInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryInstance' 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/tam.AdvisoryInstance' links: GetTamAdvisoryInstanceByMoid: operationId: GetTamAdvisoryInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/AdvisoryInstances/{Moid}: get: tags: - tam summary: Read a 'tam.AdvisoryInstance' resource. operationId: GetTamAdvisoryInstanceByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.HyperFlex Cluster - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.Server Administrator - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.tam.AdvisoryInstance - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'tam.AdvisoryInstance' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInstance' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetTamAdvisoryInstanceByMoid: operationId: GetTamAdvisoryInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Update a 'tam.AdvisoryInstance' resource. operationId: UpdateTamAdvisoryInstance security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.AdvisoryInstance parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryInstance' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInstance' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInstance' resource was modified as requested. The 'tam.AdvisoryInstance' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInstance' links: GetTamAdvisoryInstanceByMoid: operationId: GetTamAdvisoryInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryInstance' resource is asynchronously being modified 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/tam.AdvisoryInstance' links: GetTamAdvisoryInstanceByMoid: operationId: GetTamAdvisoryInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - tam summary: Update a 'tam.AdvisoryInstance' resource. operationId: PatchTamAdvisoryInstance security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.AdvisoryInstance parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.AdvisoryInstance' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInstance' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInstance' resource was patched as requested. The 'tam.AdvisoryInstance' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.AdvisoryInstance' links: GetTamAdvisoryInstanceByMoid: operationId: GetTamAdvisoryInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.AdvisoryInstance' resource is asynchronously being patched 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/tam.AdvisoryInstance' links: GetTamAdvisoryInstanceByMoid: operationId: GetTamAdvisoryInstanceByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - tam summary: Delete a 'tam.AdvisoryInstance' resource. operationId: DeleteTamAdvisoryInstance security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.tam.AdvisoryInstance 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/SecurityAdvisories: get: tags: - tam summary: Read a 'tam.SecurityAdvisory' resource. operationId: GetTamSecurityAdvisoryList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.HyperFlex Cluster - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.Server Administrator - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.tam.SecurityAdvisory - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 'tam.SecurityAdvisory' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/tam.SecurityAdvisory.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Create a 'tam.SecurityAdvisory' resource. operationId: CreateTamSecurityAdvisory security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.tam.SecurityAdvisory parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'tam.SecurityAdvisory' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/tam.SecurityAdvisory' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.SecurityAdvisory' resource was created as requested. The 'tam.SecurityAdvisory' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.SecurityAdvisory' links: GetTamSecurityAdvisoryByMoid: operationId: GetTamSecurityAdvisoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.SecurityAdvisory' 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/tam.SecurityAdvisory' links: GetTamSecurityAdvisoryByMoid: operationId: GetTamSecurityAdvisoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/tam/SecurityAdvisories/{Moid}: get: tags: - tam summary: Read a 'tam.SecurityAdvisory' resource. operationId: GetTamSecurityAdvisoryByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.HyperFlex Cluster - PRIVSET.Manage Fabric Interconnects - PRIVSET.Manage HyperFlex Clusters - PRIVSET.Manage Servers - PRIVSET.Read-Only - PRIVSET.Server Administrator - PRIVSET.View Fabric Interconnects - PRIVSET.View HyperFlex Clusters - PRIVSET.View Servers - READ.tam.SecurityAdvisory - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'tam.SecurityAdvisory' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/tam.SecurityAdvisory' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetTamSecurityAdvisoryByMoid: operationId: GetTamSecurityAdvisoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - tam summary: Update a 'tam.SecurityAdvisory' resource. operationId: UpdateTamSecurityAdvisory security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.SecurityAdvisory parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.SecurityAdvisory' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.SecurityAdvisory' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.SecurityAdvisory' resource was modified as requested. The 'tam.SecurityAdvisory' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.SecurityAdvisory' links: GetTamSecurityAdvisoryByMoid: operationId: GetTamSecurityAdvisoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.SecurityAdvisory' resource is asynchronously being modified 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/tam.SecurityAdvisory' links: GetTamSecurityAdvisoryByMoid: operationId: GetTamSecurityAdvisoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - tam summary: Update a 'tam.SecurityAdvisory' resource. operationId: PatchTamSecurityAdvisory security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.tam.SecurityAdvisory parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'tam.SecurityAdvisory' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/tam.SecurityAdvisory' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'tam.SecurityAdvisory' resource was patched as requested. The 'tam.SecurityAdvisory' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/tam.SecurityAdvisory' links: GetTamSecurityAdvisoryByMoid: operationId: GetTamSecurityAdvisoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'tam.SecurityAdvisory' resource is asynchronously being patched 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/tam.SecurityAdvisory' links: GetTamSecurityAdvisoryByMoid: operationId: GetTamSecurityAdvisoryByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - tam summary: Delete a 'tam.SecurityAdvisory' resource. operationId: DeleteTamSecurityAdvisory security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.tam.SecurityAdvisory 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'task.PureScopedInventory' 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/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/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.Servers - READ.techsupportmanagement.Download - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/techsupportmanagement.Download.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Servers - READ.techsupportmanagement.Download - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/TechSupportBundles: get: tags: - techsupportmanagement summary: Read a 'techsupportmanagement.TechSupportBundle' resource. operationId: GetTechsupportmanagementTechSupportBundleList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.HyperFlex Cluster - PRIVSET.Servers - READ.techsupportmanagement.TechSupportBundle - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/techsupportmanagement.TechSupportBundle.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Servers - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Server 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'techsupportmanagement.TechSupportBundle' 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/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.Servers - READ.techsupportmanagement.TechSupportBundle - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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.Servers - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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.Servers - READ.techsupportmanagement.TechSupportStatus - 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/techsupportmanagement.TechSupportStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.Servers - READ.techsupportmanagement.TechSupportStatus - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Server Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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/terminal/AuditLogs: get: tags: - terminal summary: Read a 'terminal.AuditLog' resource. operationId: GetTerminalAuditLogList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.terminal.AuditLog parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'terminal.AuditLog' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/terminal.AuditLog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/terminal/AuditLogs/{Moid}: get: tags: - terminal summary: Read a 'terminal.AuditLog' resource. operationId: GetTerminalAuditLogByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.terminal.AuditLog parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'terminal.AuditLog' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/terminal.AuditLog' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetTerminalAuditLogByMoid: operationId: GetTerminalAuditLogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/terminal/AuditLogs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/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.View Fabric Interconnects - PRIVSET.View Servers - READ.top.System - ROLE.Account Administrator - ROLE.HyperFlex Cluster 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 '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: # Response as JSON document. schema: $ref: '#/components/schemas/top.System.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/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.View Fabric Interconnects - PRIVSET.View Servers - READ.top.System - ROLE.Account Administrator - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' 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: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. 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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/top.System' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'top.System' resource is asynchronously being modified 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/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: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. 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' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'top.System' resource is asynchronously being patched 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/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/ucsd/BackupInfos: get: tags: - ucsd summary: Read a 'ucsd.BackupInfo' resource. operationId: GetUcsdBackupInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.ucsd.BackupInfo - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'ucsd.BackupInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/ucsd.BackupInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/ucsd/BackupInfos/{Moid}: get: tags: - ucsd summary: Read a 'ucsd.BackupInfo' resource. operationId: GetUcsdBackupInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Read-Only - READ.ucsd.BackupInfo - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'ucsd.BackupInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/ucsd.BackupInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetUcsdBackupInfoByMoid: operationId: GetUcsdBackupInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ucsd/BackupInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - ucsd summary: Delete a 'ucsd.BackupInfo' resource. operationId: DeleteUcsdBackupInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.ucsd.BackupInfo - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/Blocks: get: tags: - uuidpool summary: Read a 'uuidpool.Block' resource. operationId: GetUuidpoolBlockList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.Block - 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 'uuidpool.Block' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/uuidpool.Block.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/Blocks/{Moid}: get: tags: - uuidpool summary: Read a 'uuidpool.Block' resource. operationId: GetUuidpoolBlockByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.Block - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'uuidpool.Block' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/uuidpool.Block' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetUuidpoolBlockByMoid: operationId: GetUuidpoolBlockByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Blocks/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/Pools: get: tags: - uuidpool summary: Read a 'uuidpool.Pool' resource. operationId: GetUuidpoolPoolList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.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 'uuidpool.Pool' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/uuidpool.Pool.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - uuidpool summary: Create a 'uuidpool.Pool' resource. operationId: CreateUuidpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.uuidpool.Pool - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'uuidpool.Pool' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/uuidpool.Pool' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'uuidpool.Pool' resource was created as requested. The 'uuidpool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/uuidpool.Pool' links: GetUuidpoolPoolByMoid: operationId: GetUuidpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'uuidpool.Pool' 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/uuidpool.Pool' links: GetUuidpoolPoolByMoid: operationId: GetUuidpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/Pools/{Moid}: get: tags: - uuidpool summary: Read a 'uuidpool.Pool' resource. operationId: GetUuidpoolPoolByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.Pool - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'uuidpool.Pool' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/uuidpool.Pool' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetUuidpoolPoolByMoid: operationId: GetUuidpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - uuidpool summary: Update a 'uuidpool.Pool' resource. operationId: UpdateUuidpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.uuidpool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'uuidpool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/uuidpool.Pool' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'uuidpool.Pool' resource was modified as requested. The 'uuidpool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/uuidpool.Pool' links: GetUuidpoolPoolByMoid: operationId: GetUuidpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'uuidpool.Pool' resource is asynchronously being modified 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/uuidpool.Pool' links: GetUuidpoolPoolByMoid: operationId: GetUuidpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - uuidpool summary: Update a 'uuidpool.Pool' resource. operationId: PatchUuidpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.uuidpool.Pool parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'uuidpool.Pool' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/uuidpool.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 'uuidpool.Pool' resource was patched as requested. The 'uuidpool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/uuidpool.Pool' links: GetUuidpoolPoolByMoid: operationId: GetUuidpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'uuidpool.Pool' resource is asynchronously being patched 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/uuidpool.Pool' links: GetUuidpoolPoolByMoid: operationId: GetUuidpoolPoolByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - uuidpool summary: Delete a 'uuidpool.Pool' resource. operationId: DeleteUuidpoolPool security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.uuidpool.Pool - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/PoolMembers: get: tags: - uuidpool summary: Read a 'uuidpool.PoolMember' resource. operationId: GetUuidpoolPoolMemberList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.PoolMember - 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 'uuidpool.PoolMember' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/uuidpool.PoolMember.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/PoolMembers/{Moid}: get: tags: - uuidpool summary: Read a 'uuidpool.PoolMember' resource. operationId: GetUuidpoolPoolMemberByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.PoolMember - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'uuidpool.PoolMember' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/uuidpool.PoolMember' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetUuidpoolPoolMemberByMoid: operationId: GetUuidpoolPoolMemberByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/PoolMembers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/Universes: get: tags: - uuidpool summary: Read a 'uuidpool.Universe' resource. operationId: GetUuidpoolUniverseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.Universe - 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 'uuidpool.Universe' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/uuidpool.Universe.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/Universes/{Moid}: get: tags: - uuidpool summary: Read a 'uuidpool.Universe' resource. operationId: GetUuidpoolUniverseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.Universe - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'uuidpool.Universe' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/uuidpool.Universe' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetUuidpoolUniverseByMoid: operationId: GetUuidpoolUniverseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Universes/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/UuidLeases: get: tags: - uuidpool summary: Read a 'uuidpool.UuidLease' resource. operationId: GetUuidpoolUuidLeaseList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.UuidLease - 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 'uuidpool.UuidLease' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/uuidpool.UuidLease.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/uuidpool/UuidLeases/{Moid}: get: tags: - uuidpool summary: Read a 'uuidpool.UuidLease' resource. operationId: GetUuidpoolUuidLeaseByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.uuidpool.UuidLease - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'uuidpool.UuidLease' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/uuidpool.UuidLease' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetUuidpoolUuidLeaseByMoid: operationId: GetUuidpoolUuidLeaseByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/UuidLeases/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareClusters: get: tags: - virtualization summary: Read a 'virtualization.VmwareCluster' resource. operationId: GetVirtualizationVmwareClusterList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareCluster - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'virtualization.VmwareCluster' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/virtualization.VmwareCluster.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareClusters/{Moid}: get: tags: - virtualization summary: Read a 'virtualization.VmwareCluster' resource. operationId: GetVirtualizationVmwareClusterByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareCluster - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'virtualization.VmwareCluster' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareCluster' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVirtualizationVmwareClusterByMoid: operationId: GetVirtualizationVmwareClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareClusters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - virtualization summary: Update a 'virtualization.VmwareCluster' resource. operationId: UpdateVirtualizationVmwareCluster security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareCluster parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareCluster' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareCluster' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareCluster' resource was modified as requested. The 'virtualization.VmwareCluster' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareCluster' links: GetVirtualizationVmwareClusterByMoid: operationId: GetVirtualizationVmwareClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareClusters/{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 'virtualization.VmwareCluster' resource is asynchronously being modified 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/virtualization.VmwareCluster' links: GetVirtualizationVmwareClusterByMoid: operationId: GetVirtualizationVmwareClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareClusters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - virtualization summary: Update a 'virtualization.VmwareCluster' resource. operationId: PatchVirtualizationVmwareCluster security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareCluster parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareCluster' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareCluster' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareCluster' resource was patched as requested. The 'virtualization.VmwareCluster' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareCluster' links: GetVirtualizationVmwareClusterByMoid: operationId: GetVirtualizationVmwareClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareClusters/{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 'virtualization.VmwareCluster' resource is asynchronously being patched 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/virtualization.VmwareCluster' links: GetVirtualizationVmwareClusterByMoid: operationId: GetVirtualizationVmwareClusterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareClusters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareDatacenters: get: tags: - virtualization summary: Read a 'virtualization.VmwareDatacenter' resource. operationId: GetVirtualizationVmwareDatacenterList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareDatacenter - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'virtualization.VmwareDatacenter' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/virtualization.VmwareDatacenter.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareDatacenters/{Moid}: get: tags: - virtualization summary: Read a 'virtualization.VmwareDatacenter' resource. operationId: GetVirtualizationVmwareDatacenterByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareDatacenter - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'virtualization.VmwareDatacenter' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatacenter' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVirtualizationVmwareDatacenterByMoid: operationId: GetVirtualizationVmwareDatacenterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatacenters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - virtualization summary: Update a 'virtualization.VmwareDatacenter' resource. operationId: UpdateVirtualizationVmwareDatacenter security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareDatacenter parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareDatacenter' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatacenter' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareDatacenter' resource was modified as requested. The 'virtualization.VmwareDatacenter' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatacenter' links: GetVirtualizationVmwareDatacenterByMoid: operationId: GetVirtualizationVmwareDatacenterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatacenters/{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 'virtualization.VmwareDatacenter' resource is asynchronously being modified 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/virtualization.VmwareDatacenter' links: GetVirtualizationVmwareDatacenterByMoid: operationId: GetVirtualizationVmwareDatacenterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatacenters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - virtualization summary: Update a 'virtualization.VmwareDatacenter' resource. operationId: PatchVirtualizationVmwareDatacenter security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareDatacenter parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareDatacenter' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatacenter' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareDatacenter' resource was patched as requested. The 'virtualization.VmwareDatacenter' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatacenter' links: GetVirtualizationVmwareDatacenterByMoid: operationId: GetVirtualizationVmwareDatacenterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatacenters/{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 'virtualization.VmwareDatacenter' resource is asynchronously being patched 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/virtualization.VmwareDatacenter' links: GetVirtualizationVmwareDatacenterByMoid: operationId: GetVirtualizationVmwareDatacenterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatacenters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareDatastores: get: tags: - virtualization summary: Read a 'virtualization.VmwareDatastore' resource. operationId: GetVirtualizationVmwareDatastoreList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareDatastore - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'virtualization.VmwareDatastore' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/virtualization.VmwareDatastore.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareDatastores/{Moid}: get: tags: - virtualization summary: Read a 'virtualization.VmwareDatastore' resource. operationId: GetVirtualizationVmwareDatastoreByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareDatastore - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'virtualization.VmwareDatastore' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatastore' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVirtualizationVmwareDatastoreByMoid: operationId: GetVirtualizationVmwareDatastoreByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatastores/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - virtualization summary: Update a 'virtualization.VmwareDatastore' resource. operationId: UpdateVirtualizationVmwareDatastore security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareDatastore parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareDatastore' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatastore' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareDatastore' resource was modified as requested. The 'virtualization.VmwareDatastore' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatastore' links: GetVirtualizationVmwareDatastoreByMoid: operationId: GetVirtualizationVmwareDatastoreByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatastores/{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 'virtualization.VmwareDatastore' resource is asynchronously being modified 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/virtualization.VmwareDatastore' links: GetVirtualizationVmwareDatastoreByMoid: operationId: GetVirtualizationVmwareDatastoreByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatastores/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - virtualization summary: Update a 'virtualization.VmwareDatastore' resource. operationId: PatchVirtualizationVmwareDatastore security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareDatastore parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareDatastore' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatastore' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareDatastore' resource was patched as requested. The 'virtualization.VmwareDatastore' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareDatastore' links: GetVirtualizationVmwareDatastoreByMoid: operationId: GetVirtualizationVmwareDatastoreByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatastores/{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 'virtualization.VmwareDatastore' resource is asynchronously being patched 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/virtualization.VmwareDatastore' links: GetVirtualizationVmwareDatastoreByMoid: operationId: GetVirtualizationVmwareDatastoreByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareDatastores/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareHosts: get: tags: - virtualization summary: Read a 'virtualization.VmwareHost' resource. operationId: GetVirtualizationVmwareHostList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareHost - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'virtualization.VmwareHost' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/virtualization.VmwareHost.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareHosts/{Moid}: get: tags: - virtualization summary: Read a 'virtualization.VmwareHost' resource. operationId: GetVirtualizationVmwareHostByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareHost - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'virtualization.VmwareHost' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareHost' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVirtualizationVmwareHostByMoid: operationId: GetVirtualizationVmwareHostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareHosts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - virtualization summary: Update a 'virtualization.VmwareHost' resource. operationId: UpdateVirtualizationVmwareHost security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareHost parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareHost' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareHost' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareHost' resource was modified as requested. The 'virtualization.VmwareHost' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareHost' links: GetVirtualizationVmwareHostByMoid: operationId: GetVirtualizationVmwareHostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareHosts/{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 'virtualization.VmwareHost' resource is asynchronously being modified 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/virtualization.VmwareHost' links: GetVirtualizationVmwareHostByMoid: operationId: GetVirtualizationVmwareHostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareHosts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - virtualization summary: Update a 'virtualization.VmwareHost' resource. operationId: PatchVirtualizationVmwareHost security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareHost parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareHost' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareHost' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareHost' resource was patched as requested. The 'virtualization.VmwareHost' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareHost' links: GetVirtualizationVmwareHostByMoid: operationId: GetVirtualizationVmwareHostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareHosts/{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 'virtualization.VmwareHost' resource is asynchronously being patched 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/virtualization.VmwareHost' links: GetVirtualizationVmwareHostByMoid: operationId: GetVirtualizationVmwareHostByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareHosts/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareVcenters: get: tags: - virtualization summary: Read a 'virtualization.VmwareVcenter' resource. operationId: GetVirtualizationVmwareVcenterList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareVcenter - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'virtualization.VmwareVcenter' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/virtualization.VmwareVcenter.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareVcenters/{Moid}: get: tags: - virtualization summary: Read a 'virtualization.VmwareVcenter' resource. operationId: GetVirtualizationVmwareVcenterByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareVcenter - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'virtualization.VmwareVcenter' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareVcenter' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVirtualizationVmwareVcenterByMoid: operationId: GetVirtualizationVmwareVcenterByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareVcenters/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareVirtualMachines: get: tags: - virtualization summary: Read a 'virtualization.VmwareVirtualMachine' resource. operationId: GetVirtualizationVmwareVirtualMachineList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareVirtualMachine - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'virtualization.VmwareVirtualMachine' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/virtualization.VmwareVirtualMachine.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/virtualization/VmwareVirtualMachines/{Moid}: get: tags: - virtualization summary: Read a 'virtualization.VmwareVirtualMachine' resource. operationId: GetVirtualizationVmwareVirtualMachineByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - PRIVSET.Read-Only - PRIVSET.View Hypervisors - READ.virtualization.VmwareVirtualMachine - ROLE.Account Administrator - ROLE.Read-Only parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'virtualization.VmwareVirtualMachine' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareVirtualMachine' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVirtualizationVmwareVirtualMachineByMoid: operationId: GetVirtualizationVmwareVirtualMachineByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareVirtualMachines/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - virtualization summary: Update a 'virtualization.VmwareVirtualMachine' resource. operationId: UpdateVirtualizationVmwareVirtualMachine security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareVirtualMachine parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareVirtualMachine' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareVirtualMachine' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareVirtualMachine' resource was modified as requested. The 'virtualization.VmwareVirtualMachine' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareVirtualMachine' links: GetVirtualizationVmwareVirtualMachineByMoid: operationId: GetVirtualizationVmwareVirtualMachineByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareVirtualMachines/{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 'virtualization.VmwareVirtualMachine' resource is asynchronously being modified 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/virtualization.VmwareVirtualMachine' links: GetVirtualizationVmwareVirtualMachineByMoid: operationId: GetVirtualizationVmwareVirtualMachineByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareVirtualMachines/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - virtualization summary: Update a 'virtualization.VmwareVirtualMachine' resource. operationId: PatchVirtualizationVmwareVirtualMachine security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Hypervisors - ROLE.Account Administrator - UPDATE.virtualization.VmwareVirtualMachine parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'virtualization.VmwareVirtualMachine' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/virtualization.VmwareVirtualMachine' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'virtualization.VmwareVirtualMachine' resource was patched as requested. The 'virtualization.VmwareVirtualMachine' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/virtualization.VmwareVirtualMachine' links: GetVirtualizationVmwareVirtualMachineByMoid: operationId: GetVirtualizationVmwareVirtualMachineByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareVirtualMachines/{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 'virtualization.VmwareVirtualMachine' resource is asynchronously being patched 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/virtualization.VmwareVirtualMachine' links: GetVirtualizationVmwareVirtualMachineByMoid: operationId: GetVirtualizationVmwareVirtualMachineByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/virtualization/VmwareVirtualMachines/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vmedia/Policies: post: tags: - vmedia summary: Create a 'vmedia.Policy' resource. operationId: CreateVmediaPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vmedia.Policy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vmedia.Policy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vmedia.Policy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vmedia.Policy' resource was created as requested. The 'vmedia.Policy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vmedia.Policy' links: GetVmediaPolicyByMoid: operationId: GetVmediaPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vmedia.Policy' 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/vmedia.Policy' links: GetVmediaPolicyByMoid: operationId: GetVmediaPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' get: tags: - vmedia summary: Read a 'vmedia.Policy' resource. operationId: GetVmediaPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vmedia.Policy - 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 'vmedia.Policy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vmedia.Policy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vmedia/Policies/{Moid}: get: tags: - vmedia summary: Read a 'vmedia.Policy' resource. operationId: GetVmediaPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vmedia.Policy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vmedia.Policy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vmedia.Policy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVmediaPolicyByMoid: operationId: GetVmediaPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vmedia summary: Update a 'vmedia.Policy' resource. operationId: UpdateVmediaPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vmedia.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vmedia.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vmedia.Policy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vmedia.Policy' resource was modified as requested. The 'vmedia.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vmedia.Policy' links: GetVmediaPolicyByMoid: operationId: GetVmediaPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vmedia.Policy' resource is asynchronously being modified 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/vmedia.Policy' links: GetVmediaPolicyByMoid: operationId: GetVmediaPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vmedia summary: Update a 'vmedia.Policy' resource. operationId: PatchVmediaPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vmedia.Policy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vmedia.Policy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vmedia.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 'vmedia.Policy' resource was patched as requested. The 'vmedia.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vmedia.Policy' links: GetVmediaPolicyByMoid: operationId: GetVmediaPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vmedia.Policy' resource is asynchronously being patched 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/vmedia.Policy' links: GetVmediaPolicyByMoid: operationId: GetVmediaPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vmedia summary: Delete a 'vmedia.Policy' resource. operationId: DeleteVmediaPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vmedia.Policy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthAdapterPolicies: get: tags: - vnic summary: Read a 'vnic.EthAdapterPolicy' resource. operationId: GetVnicEthAdapterPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthAdapterPolicy - 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 'vnic.EthAdapterPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.EthAdapterPolicy' resource. operationId: CreateVnicEthAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.EthAdapterPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.EthAdapterPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthAdapterPolicy' resource was created as requested. The 'vnic.EthAdapterPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy' links: GetVnicEthAdapterPolicyByMoid: operationId: GetVnicEthAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthAdapterPolicy' 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/vnic.EthAdapterPolicy' links: GetVnicEthAdapterPolicyByMoid: operationId: GetVnicEthAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthAdapterPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.EthAdapterPolicy' resource. operationId: GetVnicEthAdapterPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthAdapterPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.EthAdapterPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicEthAdapterPolicyByMoid: operationId: GetVnicEthAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.EthAdapterPolicy' resource. operationId: UpdateVnicEthAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthAdapterPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthAdapterPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthAdapterPolicy' resource was modified as requested. The 'vnic.EthAdapterPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy' links: GetVnicEthAdapterPolicyByMoid: operationId: GetVnicEthAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthAdapterPolicy' resource is asynchronously being modified 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/vnic.EthAdapterPolicy' links: GetVnicEthAdapterPolicyByMoid: operationId: GetVnicEthAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.EthAdapterPolicy' resource. operationId: PatchVnicEthAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthAdapterPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthAdapterPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthAdapterPolicy' resource was patched as requested. The 'vnic.EthAdapterPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthAdapterPolicy' links: GetVnicEthAdapterPolicyByMoid: operationId: GetVnicEthAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthAdapterPolicy' resource is asynchronously being patched 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/vnic.EthAdapterPolicy' links: GetVnicEthAdapterPolicyByMoid: operationId: GetVnicEthAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.EthAdapterPolicy' resource. operationId: DeleteVnicEthAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.EthAdapterPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthIfs: get: tags: - vnic summary: Read a 'vnic.EthIf' resource. operationId: GetVnicEthIfList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthIf - 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 'vnic.EthIf' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.EthIf.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.EthIf' resource. operationId: CreateVnicEthIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.EthIf - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.EthIf' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.EthIf' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthIf' resource was created as requested. The 'vnic.EthIf' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthIf' links: GetVnicEthIfByMoid: operationId: GetVnicEthIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthIf' 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/vnic.EthIf' links: GetVnicEthIfByMoid: operationId: GetVnicEthIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthIfs/{Moid}: get: tags: - vnic summary: Read a 'vnic.EthIf' resource. operationId: GetVnicEthIfByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthIf - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.EthIf' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.EthIf' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicEthIfByMoid: operationId: GetVnicEthIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.EthIf' resource. operationId: UpdateVnicEthIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthIf parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthIf' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthIf' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthIf' resource was modified as requested. The 'vnic.EthIf' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthIf' links: GetVnicEthIfByMoid: operationId: GetVnicEthIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthIf' resource is asynchronously being modified 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/vnic.EthIf' links: GetVnicEthIfByMoid: operationId: GetVnicEthIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.EthIf' resource. operationId: PatchVnicEthIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthIf parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthIf' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthIf' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthIf' resource was patched as requested. The 'vnic.EthIf' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthIf' links: GetVnicEthIfByMoid: operationId: GetVnicEthIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthIf' resource is asynchronously being patched 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/vnic.EthIf' links: GetVnicEthIfByMoid: operationId: GetVnicEthIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.EthIf' resource. operationId: DeleteVnicEthIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.EthIf - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthNetworkPolicies: get: tags: - vnic summary: Read a 'vnic.EthNetworkPolicy' resource. operationId: GetVnicEthNetworkPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthNetworkPolicy - 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 'vnic.EthNetworkPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.EthNetworkPolicy' resource. operationId: CreateVnicEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.EthNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.EthNetworkPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthNetworkPolicy' resource was created as requested. The 'vnic.EthNetworkPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy' links: GetVnicEthNetworkPolicyByMoid: operationId: GetVnicEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthNetworkPolicy' 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/vnic.EthNetworkPolicy' links: GetVnicEthNetworkPolicyByMoid: operationId: GetVnicEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthNetworkPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.EthNetworkPolicy' resource. operationId: GetVnicEthNetworkPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.EthNetworkPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicEthNetworkPolicyByMoid: operationId: GetVnicEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.EthNetworkPolicy' resource. operationId: UpdateVnicEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthNetworkPolicy' resource was modified as requested. The 'vnic.EthNetworkPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy' links: GetVnicEthNetworkPolicyByMoid: operationId: GetVnicEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthNetworkPolicy' resource is asynchronously being modified 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/vnic.EthNetworkPolicy' links: GetVnicEthNetworkPolicyByMoid: operationId: GetVnicEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.EthNetworkPolicy' resource. operationId: PatchVnicEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthNetworkPolicy' resource was patched as requested. The 'vnic.EthNetworkPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthNetworkPolicy' links: GetVnicEthNetworkPolicyByMoid: operationId: GetVnicEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthNetworkPolicy' resource is asynchronously being patched 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/vnic.EthNetworkPolicy' links: GetVnicEthNetworkPolicyByMoid: operationId: GetVnicEthNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.EthNetworkPolicy' resource. operationId: DeleteVnicEthNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.EthNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthQosPolicies: get: tags: - vnic summary: Read a 'vnic.EthQosPolicy' resource. operationId: GetVnicEthQosPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthQosPolicy - 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 'vnic.EthQosPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.EthQosPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.EthQosPolicy' resource. operationId: CreateVnicEthQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.EthQosPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.EthQosPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.EthQosPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthQosPolicy' resource was created as requested. The 'vnic.EthQosPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthQosPolicy' links: GetVnicEthQosPolicyByMoid: operationId: GetVnicEthQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthQosPolicy' 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/vnic.EthQosPolicy' links: GetVnicEthQosPolicyByMoid: operationId: GetVnicEthQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/EthQosPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.EthQosPolicy' resource. operationId: GetVnicEthQosPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.EthQosPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.EthQosPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.EthQosPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicEthQosPolicyByMoid: operationId: GetVnicEthQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.EthQosPolicy' resource. operationId: UpdateVnicEthQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthQosPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthQosPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthQosPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthQosPolicy' resource was modified as requested. The 'vnic.EthQosPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthQosPolicy' links: GetVnicEthQosPolicyByMoid: operationId: GetVnicEthQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthQosPolicy' resource is asynchronously being modified 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/vnic.EthQosPolicy' links: GetVnicEthQosPolicyByMoid: operationId: GetVnicEthQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.EthQosPolicy' resource. operationId: PatchVnicEthQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.EthQosPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.EthQosPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.EthQosPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthQosPolicy' resource was patched as requested. The 'vnic.EthQosPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.EthQosPolicy' links: GetVnicEthQosPolicyByMoid: operationId: GetVnicEthQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.EthQosPolicy' resource is asynchronously being patched 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/vnic.EthQosPolicy' links: GetVnicEthQosPolicyByMoid: operationId: GetVnicEthQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.EthQosPolicy' resource. operationId: DeleteVnicEthQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.EthQosPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcAdapterPolicies: get: tags: - vnic summary: Read a 'vnic.FcAdapterPolicy' resource. operationId: GetVnicFcAdapterPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcAdapterPolicy - 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 'vnic.FcAdapterPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.FcAdapterPolicy' resource. operationId: CreateVnicFcAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.FcAdapterPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.FcAdapterPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcAdapterPolicy' resource was created as requested. The 'vnic.FcAdapterPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy' links: GetVnicFcAdapterPolicyByMoid: operationId: GetVnicFcAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcAdapterPolicy' 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/vnic.FcAdapterPolicy' links: GetVnicFcAdapterPolicyByMoid: operationId: GetVnicFcAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcAdapterPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.FcAdapterPolicy' resource. operationId: GetVnicFcAdapterPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcAdapterPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.FcAdapterPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicFcAdapterPolicyByMoid: operationId: GetVnicFcAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.FcAdapterPolicy' resource. operationId: UpdateVnicFcAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcAdapterPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcAdapterPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcAdapterPolicy' resource was modified as requested. The 'vnic.FcAdapterPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy' links: GetVnicFcAdapterPolicyByMoid: operationId: GetVnicFcAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcAdapterPolicy' resource is asynchronously being modified 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/vnic.FcAdapterPolicy' links: GetVnicFcAdapterPolicyByMoid: operationId: GetVnicFcAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.FcAdapterPolicy' resource. operationId: PatchVnicFcAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcAdapterPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcAdapterPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcAdapterPolicy' resource was patched as requested. The 'vnic.FcAdapterPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcAdapterPolicy' links: GetVnicFcAdapterPolicyByMoid: operationId: GetVnicFcAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcAdapterPolicy' resource is asynchronously being patched 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/vnic.FcAdapterPolicy' links: GetVnicFcAdapterPolicyByMoid: operationId: GetVnicFcAdapterPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.FcAdapterPolicy' resource. operationId: DeleteVnicFcAdapterPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.FcAdapterPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcIfs: get: tags: - vnic summary: Read a 'vnic.FcIf' resource. operationId: GetVnicFcIfList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcIf - 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 'vnic.FcIf' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.FcIf.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.FcIf' resource. operationId: CreateVnicFcIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.FcIf - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.FcIf' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.FcIf' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcIf' resource was created as requested. The 'vnic.FcIf' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcIf' links: GetVnicFcIfByMoid: operationId: GetVnicFcIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcIf' 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/vnic.FcIf' links: GetVnicFcIfByMoid: operationId: GetVnicFcIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcIfs/{Moid}: get: tags: - vnic summary: Read a 'vnic.FcIf' resource. operationId: GetVnicFcIfByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcIf - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.FcIf' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.FcIf' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicFcIfByMoid: operationId: GetVnicFcIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.FcIf' resource. operationId: UpdateVnicFcIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcIf parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcIf' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcIf' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcIf' resource was modified as requested. The 'vnic.FcIf' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcIf' links: GetVnicFcIfByMoid: operationId: GetVnicFcIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcIf' resource is asynchronously being modified 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/vnic.FcIf' links: GetVnicFcIfByMoid: operationId: GetVnicFcIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.FcIf' resource. operationId: PatchVnicFcIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcIf parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcIf' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcIf' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcIf' resource was patched as requested. The 'vnic.FcIf' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcIf' links: GetVnicFcIfByMoid: operationId: GetVnicFcIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcIf' resource is asynchronously being patched 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/vnic.FcIf' links: GetVnicFcIfByMoid: operationId: GetVnicFcIfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.FcIf' resource. operationId: DeleteVnicFcIf security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.FcIf - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcNetworkPolicies: get: tags: - vnic summary: Read a 'vnic.FcNetworkPolicy' resource. operationId: GetVnicFcNetworkPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcNetworkPolicy - 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 'vnic.FcNetworkPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.FcNetworkPolicy' resource. operationId: CreateVnicFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.FcNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.FcNetworkPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcNetworkPolicy' resource was created as requested. The 'vnic.FcNetworkPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy' links: GetVnicFcNetworkPolicyByMoid: operationId: GetVnicFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcNetworkPolicy' 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/vnic.FcNetworkPolicy' links: GetVnicFcNetworkPolicyByMoid: operationId: GetVnicFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcNetworkPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.FcNetworkPolicy' resource. operationId: GetVnicFcNetworkPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcNetworkPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.FcNetworkPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicFcNetworkPolicyByMoid: operationId: GetVnicFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.FcNetworkPolicy' resource. operationId: UpdateVnicFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcNetworkPolicy' resource was modified as requested. The 'vnic.FcNetworkPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy' links: GetVnicFcNetworkPolicyByMoid: operationId: GetVnicFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcNetworkPolicy' resource is asynchronously being modified 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/vnic.FcNetworkPolicy' links: GetVnicFcNetworkPolicyByMoid: operationId: GetVnicFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.FcNetworkPolicy' resource. operationId: PatchVnicFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcNetworkPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcNetworkPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcNetworkPolicy' resource was patched as requested. The 'vnic.FcNetworkPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcNetworkPolicy' links: GetVnicFcNetworkPolicyByMoid: operationId: GetVnicFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcNetworkPolicy' resource is asynchronously being patched 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/vnic.FcNetworkPolicy' links: GetVnicFcNetworkPolicyByMoid: operationId: GetVnicFcNetworkPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.FcNetworkPolicy' resource. operationId: DeleteVnicFcNetworkPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.FcNetworkPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcQosPolicies: get: tags: - vnic summary: Read a 'vnic.FcQosPolicy' resource. operationId: GetVnicFcQosPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcQosPolicy - 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 'vnic.FcQosPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.FcQosPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.FcQosPolicy' resource. operationId: CreateVnicFcQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.FcQosPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.FcQosPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.FcQosPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcQosPolicy' resource was created as requested. The 'vnic.FcQosPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcQosPolicy' links: GetVnicFcQosPolicyByMoid: operationId: GetVnicFcQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcQosPolicy' 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/vnic.FcQosPolicy' links: GetVnicFcQosPolicyByMoid: operationId: GetVnicFcQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/FcQosPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.FcQosPolicy' resource. operationId: GetVnicFcQosPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.FcQosPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.FcQosPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.FcQosPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicFcQosPolicyByMoid: operationId: GetVnicFcQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.FcQosPolicy' resource. operationId: UpdateVnicFcQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcQosPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcQosPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcQosPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcQosPolicy' resource was modified as requested. The 'vnic.FcQosPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcQosPolicy' links: GetVnicFcQosPolicyByMoid: operationId: GetVnicFcQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcQosPolicy' resource is asynchronously being modified 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/vnic.FcQosPolicy' links: GetVnicFcQosPolicyByMoid: operationId: GetVnicFcQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.FcQosPolicy' resource. operationId: PatchVnicFcQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.FcQosPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.FcQosPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.FcQosPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcQosPolicy' resource was patched as requested. The 'vnic.FcQosPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.FcQosPolicy' links: GetVnicFcQosPolicyByMoid: operationId: GetVnicFcQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.FcQosPolicy' resource is asynchronously being patched 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/vnic.FcQosPolicy' links: GetVnicFcQosPolicyByMoid: operationId: GetVnicFcQosPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.FcQosPolicy' resource. operationId: DeleteVnicFcQosPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.FcQosPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/LanConnectivityPolicies: get: tags: - vnic summary: Read a 'vnic.LanConnectivityPolicy' resource. operationId: GetVnicLanConnectivityPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.LanConnectivityPolicy - 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 'vnic.LanConnectivityPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.LanConnectivityPolicy' resource. operationId: CreateVnicLanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.LanConnectivityPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.LanConnectivityPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.LanConnectivityPolicy' resource was created as requested. The 'vnic.LanConnectivityPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' links: GetVnicLanConnectivityPolicyByMoid: operationId: GetVnicLanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.LanConnectivityPolicy' 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/vnic.LanConnectivityPolicy' links: GetVnicLanConnectivityPolicyByMoid: operationId: GetVnicLanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/LanConnectivityPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.LanConnectivityPolicy' resource. operationId: GetVnicLanConnectivityPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.LanConnectivityPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.LanConnectivityPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicLanConnectivityPolicyByMoid: operationId: GetVnicLanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.LanConnectivityPolicy' resource. operationId: UpdateVnicLanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.LanConnectivityPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.LanConnectivityPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.LanConnectivityPolicy' resource was modified as requested. The 'vnic.LanConnectivityPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' links: GetVnicLanConnectivityPolicyByMoid: operationId: GetVnicLanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.LanConnectivityPolicy' resource is asynchronously being modified 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/vnic.LanConnectivityPolicy' links: GetVnicLanConnectivityPolicyByMoid: operationId: GetVnicLanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.LanConnectivityPolicy' resource. operationId: PatchVnicLanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.LanConnectivityPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.LanConnectivityPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.LanConnectivityPolicy' resource was patched as requested. The 'vnic.LanConnectivityPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' links: GetVnicLanConnectivityPolicyByMoid: operationId: GetVnicLanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.LanConnectivityPolicy' resource is asynchronously being patched 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/vnic.LanConnectivityPolicy' links: GetVnicLanConnectivityPolicyByMoid: operationId: GetVnicLanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.LanConnectivityPolicy' resource. operationId: DeleteVnicLanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.LanConnectivityPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/LcpStatuses: get: tags: - vnic summary: Read a 'vnic.LcpStatus' resource. operationId: GetVnicLcpStatusList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.LcpStatus - 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 'vnic.LcpStatus' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.LcpStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/LcpStatuses/{Moid}: get: tags: - vnic summary: Read a 'vnic.LcpStatus' resource. operationId: GetVnicLcpStatusByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.LcpStatus - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.LcpStatus' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.LcpStatus' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicLcpStatusByMoid: operationId: GetVnicLcpStatusByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LcpStatuses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/SanConnectivityPolicies: get: tags: - vnic summary: Read a 'vnic.SanConnectivityPolicy' resource. operationId: GetVnicSanConnectivityPolicyList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.SanConnectivityPolicy - 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 'vnic.SanConnectivityPolicy' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Create a 'vnic.SanConnectivityPolicy' resource. operationId: CreateVnicSanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vnic.SanConnectivityPolicy - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vnic.SanConnectivityPolicy' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.SanConnectivityPolicy' resource was created as requested. The 'vnic.SanConnectivityPolicy' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' links: GetVnicSanConnectivityPolicyByMoid: operationId: GetVnicSanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.SanConnectivityPolicy' 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/vnic.SanConnectivityPolicy' links: GetVnicSanConnectivityPolicyByMoid: operationId: GetVnicSanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/SanConnectivityPolicies/{Moid}: get: tags: - vnic summary: Read a 'vnic.SanConnectivityPolicy' resource. operationId: GetVnicSanConnectivityPolicyByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.SanConnectivityPolicy - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.SanConnectivityPolicy' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicSanConnectivityPolicyByMoid: operationId: GetVnicSanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vnic summary: Update a 'vnic.SanConnectivityPolicy' resource. operationId: UpdateVnicSanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.SanConnectivityPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.SanConnectivityPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.SanConnectivityPolicy' resource was modified as requested. The 'vnic.SanConnectivityPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' links: GetVnicSanConnectivityPolicyByMoid: operationId: GetVnicSanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.SanConnectivityPolicy' resource is asynchronously being modified 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/vnic.SanConnectivityPolicy' links: GetVnicSanConnectivityPolicyByMoid: operationId: GetVnicSanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vnic summary: Update a 'vnic.SanConnectivityPolicy' resource. operationId: PatchVnicSanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - ROLE.Account Administrator - UPDATE.vnic.SanConnectivityPolicy parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vnic.SanConnectivityPolicy' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.SanConnectivityPolicy' resource was patched as requested. The 'vnic.SanConnectivityPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' links: GetVnicSanConnectivityPolicyByMoid: operationId: GetVnicSanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vnic.SanConnectivityPolicy' resource is asynchronously being patched 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/vnic.SanConnectivityPolicy' links: GetVnicSanConnectivityPolicyByMoid: operationId: GetVnicSanConnectivityPolicyByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vnic summary: Delete a 'vnic.SanConnectivityPolicy' resource. operationId: DeleteVnicSanConnectivityPolicy security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vnic.SanConnectivityPolicy - PRIVSET.Account Administrator - PRIVSET.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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/ScpStatuses: get: tags: - vnic summary: Read a 'vnic.ScpStatus' resource. operationId: GetVnicScpStatusList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.ScpStatus - 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 'vnic.ScpStatus' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vnic.ScpStatus.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vnic/ScpStatuses/{Moid}: get: tags: - vnic summary: Read a 'vnic.ScpStatus' resource. operationId: GetVnicScpStatusByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - READ.vnic.ScpStatus - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vnic.ScpStatus' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vnic.ScpStatus' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVnicScpStatusByMoid: operationId: GetVnicScpStatusByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/ScpStatuses/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vrf/Vrves: get: tags: - vrf summary: Read a 'vrf.Vrf' resource. operationId: GetVrfVrfList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.vrf.Vrf - 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 'vrf.Vrf' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/vrf.Vrf.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vrf summary: Create a 'vrf.Vrf' resource. operationId: CreateVrfVrf security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.vrf.Vrf - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'vrf.Vrf' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/vrf.Vrf' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vrf.Vrf' resource was created as requested. The 'vrf.Vrf' resource is created before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vrf.Vrf' links: GetVrfVrfByMoid: operationId: GetVrfVrfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vrf.Vrf' 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/vrf.Vrf' links: GetVrfVrfByMoid: operationId: GetVrfVrfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/vrf/Vrves/{Moid}: get: tags: - vrf summary: Read a 'vrf.Vrf' resource. operationId: GetVrfVrfByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Server Profiles - PRIVSET.Manage Switch Profiles - PRIVSET.Read-Only - PRIVSET.View Server Profiles - PRIVSET.View Switch Profiles - READ.vrf.Vrf - ROLE.Account Administrator - ROLE.Read-Only - ROLE.UCS Domain Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'vrf.Vrf' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/vrf.Vrf' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetVrfVrfByMoid: operationId: GetVrfVrfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - vrf summary: Update a 'vrf.Vrf' resource. operationId: UpdateVrfVrf security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.vrf.Vrf parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vrf.Vrf' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vrf.Vrf' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vrf.Vrf' resource was modified as requested. The 'vrf.Vrf' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vrf.Vrf' links: GetVrfVrfByMoid: operationId: GetVrfVrfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vrf.Vrf' resource is asynchronously being modified 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/vrf.Vrf' links: GetVrfVrfByMoid: operationId: GetVrfVrfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - vrf summary: Update a 'vrf.Vrf' resource. operationId: PatchVrfVrf security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator - UPDATE.vrf.Vrf parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'vrf.Vrf' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/vrf.Vrf' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'vrf.Vrf' resource was patched as requested. The 'vrf.Vrf' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/vrf.Vrf' links: GetVrfVrfByMoid: operationId: GetVrfVrfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '202': description: >- The HTTP 202 status response code indicates that the request has succeeded. The 'vrf.Vrf' resource is asynchronously being patched 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/vrf.Vrf' links: GetVrfVrfByMoid: operationId: GetVrfVrfByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' delete: tags: - vrf summary: Delete a 'vrf.Vrf' resource. operationId: DeleteVrfVrf security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.vrf.Vrf - PRIVSET.Account Administrator - PRIVSET.Manage Switch Profiles - ROLE.Account Administrator parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "Resource has been deleted successfully." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/workflow/BatchApiExecutors: get: tags: - workflow summary: Read a 'workflow.BatchApiExecutor' resource. operationId: GetWorkflowBatchApiExecutorList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - PRIVSET.View Workflow Definitions - READ.workflow.BatchApiExecutor - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - 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 'workflow.BatchApiExecutor' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.BatchApiExecutor.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Create a 'workflow.BatchApiExecutor' resource. operationId: CreateWorkflowBatchApiExecutor security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.workflow.BatchApiExecutor parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'workflow.BatchApiExecutor' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/workflow.BatchApiExecutor' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was created as requested. The 'workflow.BatchApiExecutor' 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/workflow.BatchApiExecutor' links: GetWorkflowBatchApiExecutorByMoid: operationId: GetWorkflowBatchApiExecutorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{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 'workflow.BatchApiExecutor' 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/workflow.BatchApiExecutor' links: GetWorkflowBatchApiExecutorByMoid: operationId: GetWorkflowBatchApiExecutorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/BatchApiExecutors/{Moid}: get: tags: - workflow summary: Read a 'workflow.BatchApiExecutor' resource. operationId: GetWorkflowBatchApiExecutorByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - PRIVSET.View Workflow Definitions - READ.workflow.BatchApiExecutor - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.BatchApiExecutor' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.BatchApiExecutor' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowBatchApiExecutorByMoid: operationId: GetWorkflowBatchApiExecutorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Update a 'workflow.BatchApiExecutor' resource. operationId: UpdateWorkflowBatchApiExecutor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.workflow.BatchApiExecutor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.BatchApiExecutor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.BatchApiExecutor' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was modified as requested. The 'workflow.BatchApiExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.BatchApiExecutor' links: GetWorkflowBatchApiExecutorByMoid: operationId: GetWorkflowBatchApiExecutorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{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 'workflow.BatchApiExecutor' resource is asynchronously being modified 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/workflow.BatchApiExecutor' links: GetWorkflowBatchApiExecutorByMoid: operationId: GetWorkflowBatchApiExecutorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - workflow summary: Update a 'workflow.BatchApiExecutor' resource. operationId: PatchWorkflowBatchApiExecutor security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.workflow.BatchApiExecutor parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.BatchApiExecutor' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.BatchApiExecutor' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was patched as requested. The 'workflow.BatchApiExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.BatchApiExecutor' links: GetWorkflowBatchApiExecutorByMoid: operationId: GetWorkflowBatchApiExecutorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{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 'workflow.BatchApiExecutor' resource is asynchronously being patched 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/workflow.BatchApiExecutor' links: GetWorkflowBatchApiExecutorByMoid: operationId: GetWorkflowBatchApiExecutorByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - workflow summary: Delete a 'workflow.BatchApiExecutor' resource. operationId: DeleteWorkflowBatchApiExecutor security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.workflow.BatchApiExecutor 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/workflow/BuildTaskMeta: get: tags: - workflow summary: Read a 'workflow.BuildTaskMeta' resource. operationId: GetWorkflowBuildTaskMetaList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.workflow.BuildTaskMeta parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'workflow.BuildTaskMeta' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.BuildTaskMeta.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/BuildTaskMeta/{Moid}: get: tags: - workflow summary: Read a 'workflow.BuildTaskMeta' resource. operationId: GetWorkflowBuildTaskMetaByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.workflow.BuildTaskMeta parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.BuildTaskMeta' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.BuildTaskMeta' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowBuildTaskMetaByMoid: operationId: GetWorkflowBuildTaskMetaByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BuildTaskMeta/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/BuildTaskMetaOwners: get: tags: - workflow summary: Read a 'workflow.BuildTaskMetaOwner' resource. operationId: GetWorkflowBuildTaskMetaOwnerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.workflow.BuildTaskMetaOwner parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'workflow.BuildTaskMetaOwner' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.BuildTaskMetaOwner.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/BuildTaskMetaOwners/{Moid}: get: tags: - workflow summary: Read a 'workflow.BuildTaskMetaOwner' resource. operationId: GetWorkflowBuildTaskMetaOwnerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.workflow.BuildTaskMetaOwner parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.BuildTaskMetaOwner' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.BuildTaskMetaOwner' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowBuildTaskMetaOwnerByMoid: operationId: GetWorkflowBuildTaskMetaOwnerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BuildTaskMetaOwners/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/Catalogs: get: tags: - workflow summary: Read a 'workflow.Catalog' resource. operationId: GetWorkflowCatalogList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Workflow Definitions - READ.workflow.Catalog - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - 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 'workflow.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: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.Catalog.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/Catalogs/{Moid}: get: tags: - workflow summary: Read a 'workflow.Catalog' resource. operationId: GetWorkflowCatalogByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.View Workflow Definitions - READ.workflow.Catalog - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.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/workflow.Catalog' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowCatalogByMoid: operationId: GetWorkflowCatalogByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/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/workflow/CustomDataTypeDefinitions: get: tags: - workflow summary: Read a 'workflow.CustomDataTypeDefinition' resource. operationId: GetWorkflowCustomDataTypeDefinitionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.CustomDataTypeDefinition - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - 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 'workflow.CustomDataTypeDefinition' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Create a 'workflow.CustomDataTypeDefinition' resource. operationId: CreateWorkflowCustomDataTypeDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.workflow.CustomDataTypeDefinition - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'workflow.CustomDataTypeDefinition' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was created as requested. The 'workflow.CustomDataTypeDefinition' 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/workflow.CustomDataTypeDefinition' links: GetWorkflowCustomDataTypeDefinitionByMoid: operationId: GetWorkflowCustomDataTypeDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{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 'workflow.CustomDataTypeDefinition' 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/workflow.CustomDataTypeDefinition' links: GetWorkflowCustomDataTypeDefinitionByMoid: operationId: GetWorkflowCustomDataTypeDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/CustomDataTypeDefinitions/{Moid}: get: tags: - workflow summary: Read a 'workflow.CustomDataTypeDefinition' resource. operationId: GetWorkflowCustomDataTypeDefinitionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.CustomDataTypeDefinition - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.CustomDataTypeDefinition' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowCustomDataTypeDefinitionByMoid: operationId: GetWorkflowCustomDataTypeDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Update a 'workflow.CustomDataTypeDefinition' resource. operationId: UpdateWorkflowCustomDataTypeDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Workflow Designer - UPDATE.workflow.CustomDataTypeDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.CustomDataTypeDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was modified as requested. The 'workflow.CustomDataTypeDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition' links: GetWorkflowCustomDataTypeDefinitionByMoid: operationId: GetWorkflowCustomDataTypeDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{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 'workflow.CustomDataTypeDefinition' resource is asynchronously being modified 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/workflow.CustomDataTypeDefinition' links: GetWorkflowCustomDataTypeDefinitionByMoid: operationId: GetWorkflowCustomDataTypeDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - workflow summary: Update a 'workflow.CustomDataTypeDefinition' resource. operationId: PatchWorkflowCustomDataTypeDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Workflow Designer - UPDATE.workflow.CustomDataTypeDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.CustomDataTypeDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was patched as requested. The 'workflow.CustomDataTypeDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition' links: GetWorkflowCustomDataTypeDefinitionByMoid: operationId: GetWorkflowCustomDataTypeDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{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 'workflow.CustomDataTypeDefinition' resource is asynchronously being patched 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/workflow.CustomDataTypeDefinition' links: GetWorkflowCustomDataTypeDefinitionByMoid: operationId: GetWorkflowCustomDataTypeDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - workflow summary: Delete a 'workflow.CustomDataTypeDefinition' resource. operationId: DeleteWorkflowCustomDataTypeDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.workflow.CustomDataTypeDefinition - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/workflow/ErrorResponseHandlers: get: tags: - workflow summary: Read a 'workflow.ErrorResponseHandler' resource. operationId: GetWorkflowErrorResponseHandlerList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - PRIVSET.View Workflow Definitions - READ.workflow.ErrorResponseHandler - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - 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 'workflow.ErrorResponseHandler' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.ErrorResponseHandler.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Create a 'workflow.ErrorResponseHandler' resource. operationId: CreateWorkflowErrorResponseHandler security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.workflow.ErrorResponseHandler parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'workflow.ErrorResponseHandler' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/workflow.ErrorResponseHandler' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was created as requested. The 'workflow.ErrorResponseHandler' 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/workflow.ErrorResponseHandler' links: GetWorkflowErrorResponseHandlerByMoid: operationId: GetWorkflowErrorResponseHandlerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{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 'workflow.ErrorResponseHandler' 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/workflow.ErrorResponseHandler' links: GetWorkflowErrorResponseHandlerByMoid: operationId: GetWorkflowErrorResponseHandlerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/ErrorResponseHandlers/{Moid}: get: tags: - workflow summary: Read a 'workflow.ErrorResponseHandler' resource. operationId: GetWorkflowErrorResponseHandlerByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - PRIVSET.View Workflow Definitions - READ.workflow.ErrorResponseHandler - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.ErrorResponseHandler' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.ErrorResponseHandler' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowErrorResponseHandlerByMoid: operationId: GetWorkflowErrorResponseHandlerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Update a 'workflow.ErrorResponseHandler' resource. operationId: UpdateWorkflowErrorResponseHandler security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.workflow.ErrorResponseHandler parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.ErrorResponseHandler' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.ErrorResponseHandler' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was modified as requested. The 'workflow.ErrorResponseHandler' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.ErrorResponseHandler' links: GetWorkflowErrorResponseHandlerByMoid: operationId: GetWorkflowErrorResponseHandlerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{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 'workflow.ErrorResponseHandler' resource is asynchronously being modified 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/workflow.ErrorResponseHandler' links: GetWorkflowErrorResponseHandlerByMoid: operationId: GetWorkflowErrorResponseHandlerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - workflow summary: Update a 'workflow.ErrorResponseHandler' resource. operationId: PatchWorkflowErrorResponseHandler security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.workflow.ErrorResponseHandler parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.ErrorResponseHandler' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.ErrorResponseHandler' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was patched as requested. The 'workflow.ErrorResponseHandler' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.ErrorResponseHandler' links: GetWorkflowErrorResponseHandlerByMoid: operationId: GetWorkflowErrorResponseHandlerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{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 'workflow.ErrorResponseHandler' resource is asynchronously being patched 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/workflow.ErrorResponseHandler' links: GetWorkflowErrorResponseHandlerByMoid: operationId: GetWorkflowErrorResponseHandlerByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - workflow summary: Delete a 'workflow.ErrorResponseHandler' resource. operationId: DeleteWorkflowErrorResponseHandler security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.workflow.ErrorResponseHandler 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/workflow/PendingDynamicWorkflowInfos: get: tags: - workflow summary: Read a 'workflow.PendingDynamicWorkflowInfo' resource. operationId: GetWorkflowPendingDynamicWorkflowInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.workflow.PendingDynamicWorkflowInfo parameters: - $ref: '#/components/parameters/filterParam' - $ref: '#/components/parameters/orderbyParam' - $ref: '#/components/parameters/topParam' - $ref: '#/components/parameters/skipParam' - $ref: '#/components/parameters/selectParam' - $ref: '#/components/parameters/expandParam' - $ref: '#/components/parameters/applyParam' - $ref: '#/components/parameters/countParam' - $ref: '#/components/parameters/inlinecountParam' - $ref: '#/components/parameters/atParam' - $ref: '#/components/parameters/tagsParam' responses: '200': description: "List of 'workflow.PendingDynamicWorkflowInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.PendingDynamicWorkflowInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/PendingDynamicWorkflowInfos/{Moid}: get: tags: - workflow summary: Read a 'workflow.PendingDynamicWorkflowInfo' resource. operationId: GetWorkflowPendingDynamicWorkflowInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - READ.workflow.PendingDynamicWorkflowInfo parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.PendingDynamicWorkflowInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.PendingDynamicWorkflowInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowPendingDynamicWorkflowInfoByMoid: operationId: GetWorkflowPendingDynamicWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PendingDynamicWorkflowInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/TaskDefinitions: get: tags: - workflow summary: Read a 'workflow.TaskDefinition' resource. operationId: GetWorkflowTaskDefinitionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.TaskDefinition - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - 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 'workflow.TaskDefinition' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.TaskDefinition.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Create a 'workflow.TaskDefinition' resource. operationId: CreateWorkflowTaskDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.workflow.TaskDefinition parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'workflow.TaskDefinition' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/workflow.TaskDefinition' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was created as requested. The 'workflow.TaskDefinition' 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/workflow.TaskDefinition' links: GetWorkflowTaskDefinitionByMoid: operationId: GetWorkflowTaskDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{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 'workflow.TaskDefinition' 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/workflow.TaskDefinition' links: GetWorkflowTaskDefinitionByMoid: operationId: GetWorkflowTaskDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/TaskDefinitions/{Moid}: get: tags: - workflow summary: Read a 'workflow.TaskDefinition' resource. operationId: GetWorkflowTaskDefinitionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.TaskDefinition - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.TaskDefinition' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.TaskDefinition' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowTaskDefinitionByMoid: operationId: GetWorkflowTaskDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Update a 'workflow.TaskDefinition' resource. operationId: UpdateWorkflowTaskDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.workflow.TaskDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.TaskDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.TaskDefinition' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was modified as requested. The 'workflow.TaskDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.TaskDefinition' links: GetWorkflowTaskDefinitionByMoid: operationId: GetWorkflowTaskDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{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 'workflow.TaskDefinition' resource is asynchronously being modified 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/workflow.TaskDefinition' links: GetWorkflowTaskDefinitionByMoid: operationId: GetWorkflowTaskDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - workflow summary: Update a 'workflow.TaskDefinition' resource. operationId: PatchWorkflowTaskDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - UPDATE.workflow.TaskDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.TaskDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.TaskDefinition' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was patched as requested. The 'workflow.TaskDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.TaskDefinition' links: GetWorkflowTaskDefinitionByMoid: operationId: GetWorkflowTaskDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{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 'workflow.TaskDefinition' resource is asynchronously being patched 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/workflow.TaskDefinition' links: GetWorkflowTaskDefinitionByMoid: operationId: GetWorkflowTaskDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - workflow summary: Delete a 'workflow.TaskDefinition' resource. operationId: DeleteWorkflowTaskDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.workflow.TaskDefinition 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/workflow/TaskInfos: get: tags: - workflow summary: Read a 'workflow.TaskInfo' resource. operationId: GetWorkflowTaskInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - PRIVSET.View Workflow Executions - READ.workflow.TaskInfo - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 'workflow.TaskInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.TaskInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/TaskInfos/{Moid}: get: tags: - workflow summary: Read a 'workflow.TaskInfo' resource. operationId: GetWorkflowTaskInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - PRIVSET.View Workflow Executions - READ.workflow.TaskInfo - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.TaskInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.TaskInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowTaskInfoByMoid: operationId: GetWorkflowTaskInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Update a 'workflow.TaskInfo' resource. operationId: UpdateWorkflowTaskInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer - UPDATE.workflow.TaskInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.TaskInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.TaskInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskInfo' resource was modified as requested. The 'workflow.TaskInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.TaskInfo' links: GetWorkflowTaskInfoByMoid: operationId: GetWorkflowTaskInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{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 'workflow.TaskInfo' resource is asynchronously being modified 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/workflow.TaskInfo' links: GetWorkflowTaskInfoByMoid: operationId: GetWorkflowTaskInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - workflow summary: Update a 'workflow.TaskInfo' resource. operationId: PatchWorkflowTaskInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer - UPDATE.workflow.TaskInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.TaskInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.TaskInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskInfo' resource was patched as requested. The 'workflow.TaskInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.TaskInfo' links: GetWorkflowTaskInfoByMoid: operationId: GetWorkflowTaskInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{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 'workflow.TaskInfo' resource is asynchronously being patched 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/workflow.TaskInfo' links: GetWorkflowTaskInfoByMoid: operationId: GetWorkflowTaskInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/WorkflowDefinitions: get: tags: - workflow summary: Read a 'workflow.WorkflowDefinition' resource. operationId: GetWorkflowWorkflowDefinitionList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.WorkflowDefinition - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - 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 'workflow.WorkflowDefinition' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.WorkflowDefinition.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Create a 'workflow.WorkflowDefinition' resource. operationId: CreateWorkflowWorkflowDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.workflow.WorkflowDefinition - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'workflow.WorkflowDefinition' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowDefinition' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was created as requested. The 'workflow.WorkflowDefinition' 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/workflow.WorkflowDefinition' links: GetWorkflowWorkflowDefinitionByMoid: operationId: GetWorkflowWorkflowDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{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 'workflow.WorkflowDefinition' 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/workflow.WorkflowDefinition' links: GetWorkflowWorkflowDefinitionByMoid: operationId: GetWorkflowWorkflowDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/WorkflowDefinitions/{Moid}: get: tags: - workflow summary: Read a 'workflow.WorkflowDefinition' resource. operationId: GetWorkflowWorkflowDefinitionByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.WorkflowDefinition - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.WorkflowDefinition' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowDefinition' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowWorkflowDefinitionByMoid: operationId: GetWorkflowWorkflowDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Update a 'workflow.WorkflowDefinition' resource. operationId: UpdateWorkflowWorkflowDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Workflow Designer - UPDATE.workflow.WorkflowDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.WorkflowDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.WorkflowDefinition' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was modified as requested. The 'workflow.WorkflowDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowDefinition' links: GetWorkflowWorkflowDefinitionByMoid: operationId: GetWorkflowWorkflowDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{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 'workflow.WorkflowDefinition' resource is asynchronously being modified 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/workflow.WorkflowDefinition' links: GetWorkflowWorkflowDefinitionByMoid: operationId: GetWorkflowWorkflowDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - workflow summary: Update a 'workflow.WorkflowDefinition' resource. operationId: PatchWorkflowWorkflowDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Workflow Designer - UPDATE.workflow.WorkflowDefinition parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.WorkflowDefinition' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.WorkflowDefinition' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was patched as requested. The 'workflow.WorkflowDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowDefinition' links: GetWorkflowWorkflowDefinitionByMoid: operationId: GetWorkflowWorkflowDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{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 'workflow.WorkflowDefinition' resource is asynchronously being patched 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/workflow.WorkflowDefinition' links: GetWorkflowWorkflowDefinitionByMoid: operationId: GetWorkflowWorkflowDefinitionByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - workflow summary: Delete a 'workflow.WorkflowDefinition' resource. operationId: DeleteWorkflowWorkflowDefinition security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.workflow.WorkflowDefinition - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/workflow/WorkflowInfos: get: tags: - workflow summary: Read a 'workflow.WorkflowInfo' resource. operationId: GetWorkflowWorkflowInfoList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - PRIVSET.View Workflow Executions - READ.workflow.WorkflowInfo - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - 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 'workflow.WorkflowInfo' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.WorkflowInfo.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Create a 'workflow.WorkflowInfo' resource. operationId: CreateWorkflowWorkflowInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - CREATE.workflow.WorkflowInfo - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/IfMatch' - $ref: '#/components/parameters/IfNoneMatch' requestBody: description: The 'workflow.WorkflowInfo' resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowInfo' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was created as requested. The 'workflow.WorkflowInfo' 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/workflow.WorkflowInfo' links: GetWorkflowWorkflowInfoByMoid: operationId: GetWorkflowWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{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 'workflow.WorkflowInfo' 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/workflow.WorkflowInfo' links: GetWorkflowWorkflowInfoByMoid: operationId: GetWorkflowWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/WorkflowInfos/{Moid}: get: tags: - workflow summary: Read a 'workflow.WorkflowInfo' resource. operationId: GetWorkflowWorkflowInfoByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - PRIVSET.View Workflow Executions - READ.workflow.WorkflowInfo - ROLE.Account Administrator - ROLE.Device Administrator - ROLE.Device Technician - ROLE.HyperFlex Cluster Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.UCS Domain Administrator - ROLE.User Access Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.WorkflowInfo' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowInfo' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowWorkflowInfoByMoid: operationId: GetWorkflowWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' post: tags: - workflow summary: Update a 'workflow.WorkflowInfo' resource. operationId: UpdateWorkflowWorkflowInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer - UPDATE.workflow.WorkflowInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.WorkflowInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.WorkflowInfo' # Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was modified as requested. The 'workflow.WorkflowInfo' resource is modified before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowInfo' links: GetWorkflowWorkflowInfoByMoid: operationId: GetWorkflowWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{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 'workflow.WorkflowInfo' resource is asynchronously being modified 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/workflow.WorkflowInfo' links: GetWorkflowWorkflowInfoByMoid: operationId: GetWorkflowWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' patch: tags: - workflow summary: Update a 'workflow.WorkflowInfo' resource. operationId: PatchWorkflowWorkflowInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer - UPDATE.workflow.WorkflowInfo parameters: - $ref: '#/components/parameters/moidParam' - $ref: '#/components/parameters/IfMatch' requestBody: description: The 'workflow.WorkflowInfo' resource to update. required: true content: # The order of the content types is important (application/json first) because the OpenAPITools generator # uses the first one in the list. application/json: schema: $ref: '#/components/schemas/workflow.WorkflowInfo' application/json-patch+json: schema: $ref: '#/components/schemas/PatchDocument' responses: '200': description: >- The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was patched as requested. The 'workflow.WorkflowInfo' resource is patched before this response is sent back and the resource is returned in the body of the message. headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowInfo' links: GetWorkflowWorkflowInfoByMoid: operationId: GetWorkflowWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{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 'workflow.WorkflowInfo' resource is asynchronously being patched 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/workflow.WorkflowInfo' links: GetWorkflowWorkflowInfoByMoid: operationId: GetWorkflowWorkflowInfoByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: - workflow summary: Delete a 'workflow.WorkflowInfo' resource. operationId: DeleteWorkflowWorkflowInfo security: - cookieAuth: [] - http_signature: [] - oAuth2: - DELETE.workflow.WorkflowInfo - PRIVSET.Account Administrator - PRIVSET.Execute Workflows - PRIVSET.Manage Workflow Definitions - ROLE.Account Administrator - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization 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' '202': description: "The request has been accepted, the resource is being deleted asynchronously." 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/workflow/WorkflowMeta: get: tags: - workflow summary: Read a 'workflow.WorkflowMeta' resource. operationId: GetWorkflowWorkflowMetaList security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.WorkflowMeta - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - 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 'workflow.WorkflowMeta' resources for the given filter criteria" headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: # Response as JSON document. schema: $ref: '#/components/schemas/workflow.WorkflowMeta.Response' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/components/responses/http_status_401' '403': $ref: '#/components/responses/http_status_403' '404': $ref: '#/components/responses/http_status_404' default: $ref: '#/components/responses/default' /api/v1/workflow/WorkflowMeta/{Moid}: get: tags: - workflow summary: Read a 'workflow.WorkflowMeta' resource. operationId: GetWorkflowWorkflowMetaByMoid security: - cookieAuth: [] - http_signature: [] - oAuth2: - PRIVSET.Account Administrator - PRIVSET.Manage Workflow Definitions - PRIVSET.Read-Only - PRIVSET.View Workflow Definitions - READ.workflow.WorkflowMeta - ROLE.Account Administrator - ROLE.Read-Only - ROLE.Server Administrator - ROLE.Storage Administrator - ROLE.Virtualization Administrator - ROLE.Workflow Designer parameters: - $ref: '#/components/parameters/moidParam' responses: '200': description: "An instance of the 'workflow.WorkflowMeta' resource." headers: Set-Cookie: $ref: '#/components/headers/Set-Cookie' x-starship-traceid: $ref: '#/components/headers/x-starship-traceid' Content-Disposition: $ref: '#/components/headers/Content-Disposition' Content-Length: $ref: '#/components/headers/Content-Length' content: application/json: schema: $ref: '#/components/schemas/workflow.WorkflowMeta' text/csv: # Export data as CSV file. schema: $ref: '#/components/schemas/CsvFile' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: # Export data as Excel spreadsheet. schema: $ref: '#/components/schemas/ExcelFile' links: GetWorkflowWorkflowMetaByMoid: operationId: GetWorkflowWorkflowMetaByMoid parameters: Moid: '$response.body#/Moid' description: The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowMeta/{Moid}'. GetIamAccountByMoid: $ref: '#/components/links/GetIamAccountByMoid' GetIamDomainGroupByMoid: $ref: '#/components/links/GetIamDomainGroupByMoid' '400': $ref: '#/components/responses/http_status_400' '401': $ref: '#/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: type: string enum: - timeseries - topN - groupBy - scan - timeBoundary - segmentMetadata - dataSourceMetadata - search telemetry.DruidAggregateRequest: description: |- Exposes a REST endpoint for performing queries against Druid time series data. View Telemetry allows [POST of a Druid query](http://druid.io/docs/latest/querying/querying). Manage Telemetry allows [READ of broker status](http://druid.io/docs/latest/operations/api-reference.html#broker). oneOf: - $ref: '#/components/schemas/telemetry.DruidTimeSeriesRequest' - $ref: '#/components/schemas/telemetry.DruidTopNRequest' - $ref: '#/components/schemas/telemetry.DruidGroupByRequest' - $ref: '#/components/schemas/telemetry.DruidScanRequest' - $ref: '#/components/schemas/telemetry.DruidTimeBoundaryRequest' - $ref: '#/components/schemas/telemetry.DruidSegmentMetadataRequest' - $ref: '#/components/schemas/telemetry.DruidDataSourceMetadataRequest' discriminator: propertyName: queryType mapping: timeseries: '#/components/schemas/telemetry.DruidTimeSeriesRequest' topN: '#/components/schemas/telemetry.DruidTopNRequest' groupBy: '#/components/schemas/telemetry.DruidGroupByRequest' scan: '#/components/schemas/telemetry.DruidScanRequest' timeBoundary: '#/components/schemas/telemetry.DruidTimeBoundaryRequest' segmentMetadata: '#/components/schemas/telemetry.DruidSegmentMetadataRequest' dataSourceMetadata: '#/components/schemas/telemetry.DruidDataSourceMetadataRequest' telemetry.DruidIntervalResult: description: The time series results for a particular time stamp. 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.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, or how it gets aggregated by hour, day, minute, etc. It can be specified either as a string for simple granularities or as an object for arbitrary granularities. See [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. Duration granularity values are in milliseconds. They also support specifying an optional origin, which defines where to start counting time 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. The 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, minutes and seconds (e.g. P2W, P3M, PT1H30M, PT0.750S) in ISO8601 format. They support specifying a time zone which determines where period boundaries start as well as the timezone of the returned timestamps. By default, years start on the first of January, months start on the first of the month and weeks start on Mondays unless an origin is specified. Time 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 masquerade as a data source, providing subquery-like functionality. Query data sources are currently 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 masquerade as a data source, providing subquery-like functionality. Query data sources are currently 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: type: string outputName: description: type: string outputType: description: 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: type: string outputName: description: type: string outputType: description: type: string enum: - STRING - LONG - FLOAT default: STRING extractionFn: $ref: '#/components/schemas/telemetry.DruidExtractionFunction' telemetry.DruidExtractionFunction: description: |- All filters except the "spatial" filter support extraction functions. An extraction function is defined by setting the "extractionFn" field on a filter. See Extraction function for more details on extraction functions. If specified, the extraction function will be used to transform input values before the filter is applied. The example below shows a selector filter combined with an extraction function. This filter will transform input values according to the values defined in the lookup map; transformed values will then be matched with the string "bar_1". type: object example: type: lookup lookup: type: map map: product_1: bar_1 product_5: bar_1 product_3: bar_1 telemetry.DruidBaseHavingFilter: type: object description: |- A having clause is a JSON object identifying which rows from a groupBy query should be returned, by specifying conditions on aggregated values. It 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 for 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: 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: 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. It’s essentially the equivalent of the WHERE clause in SQL. required: - type properties: type: type: string description: The filter type. enum: - selector - columnComparison - regex - and - or - not extractionFn: $ref: '#/components/schemas/telemetry.DruidExtractionFunction' telemetry.DruidFilter: oneOf: - $ref: '#/components/schemas/telemetry.DruidSelectorFilter' - $ref: '#/components/schemas/telemetry.DruidColumnComparisonFilter' - $ref: '#/components/schemas/telemetry.DruidRegexFilter' - $ref: '#/components/schemas/telemetry.DruidAndFilter' - $ref: '#/components/schemas/telemetry.DruidOrFilter' - $ref: '#/components/schemas/telemetry.DruidNotFilter' discriminator: propertyName: type mapping: selector: '#/components/schemas/telemetry.DruidSelectorFilter' columnComparison: '#/components/schemas/telemetry.DruidColumnComparisonFilter' regex: '#/components/schemas/telemetry.DruidRegexFilter' and: '#/components/schemas/telemetry.DruidAndFilter' or: '#/components/schemas/telemetry.DruidOrFilter' not: '#/components/schemas/telemetry.DruidNotFilter' telemetry.DruidSelectorFilter: description: |- The selector filter matches a specific dimension with a specific value. Selector filters can be used as the base filters for more complex Boolean expressions of filters. The selector filter supports the use of extraction functions. See [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: - dimension - value properties: dimension: description: The name of a dimension. type: string value: description: The value of a dimension. type: string telemetry.DruidColumnComparisonFilter: description: |- The column comparison filter compares dimensions to each other. allOf: - $ref: '#/components/schemas/telemetry.DruidBaseFilter' - type: object required: - dimensions properties: 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 selector filter matches a specific dimension with a specific value. Selector filters can be used as the base filters for more complex Boolean expressions of filters. allOf: - $ref: '#/components/schemas/telemetry.DruidBaseFilter' - type: object required: - dimension - pattern properties: dimension: description: type: string pattern: description: type: string telemetry.DruidAndFilter: description: |- A logical AND expression filter. allOf: - $ref: '#/components/schemas/telemetry.DruidBaseFilter' - type: object required: - fields properties: 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 properties: 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 properties: 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 only be specified as part of queries. Note that queries with first/last aggregators on a segment created with rollup enabled will return 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 minimum/maximum timestamp value. type: string fieldName: description: Name of the metric column. type: string maxStringBytes: description: type: integer default: 1024 telemetry.DruidAnyAggregator: description: |- Returns any value including null. This aggregator can simplify and optimize the 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 the 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: type: integer default: 1024 telemetry.DruidFilteredAggregator: description: |- A filtered aggregator wraps any given aggregator, but only aggregates the values for which the given dimension filter matches. This makes it possible to compute the results of a filtered and an unfiltered aggregation simultaneously, without having to issue multiple queries, and use both results as part of post-aggregations. If only the filtered results are required, consider putting the filter on the query itself, 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, or sketches that can produce results orders-of magnitude faster and with mathematically proven error bounds. For interactive queries there may not be other viable alternatives, and in the case of real-time analysis, sketches are the only known solution. In the analysis of big data there are often problem queries that don’t scale because they require huge compute resources and time to generate exact results. Examples include count distinct, quantiles, most-frequent items, joins, matrix computations, and graph analysis. If approximate results are acceptable, theta sketch aggregation can be used. Logically speaking, a Theta sketch object can be thought of as a set data structure. Sketches are read and aggregated (set unioned) together. A theta sketch query returns the estimate of the number of unique entries in the sketch object. You can use post aggregators to do union, intersection or difference on sketch columns in the same row. You can use thetaSketch aggregator on columns which were not ingested using the same. It 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: 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: type: string enum: - ascending - descending dimensionOrder: description: type: string enum: - lexicographic - alphanumeric - strlen - numeric telemetry.DruidBasePostAggregator: type: object 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. required: - type properties: type: description: The post-aggregator type. type: string enum: - arithmetic - fieldAccess - finalizingFieldAccess - constant - doubleGreatest - longGreatest - doubleLeast - longLeast - hyperUniqueCardinality - thetaSketchEstimate - thetaSketchSetOp telemetry.DruidPostAggregator: oneOf: - $ref: '#/components/schemas/telemetry.DruidArithmeticPostAggregator' - $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' 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. The fields can be aggregators or other post aggregators. Supported functions are +, -, *, /, and quotient. / division always returns 0 if dividing by 0, regardless of the numerator. quotient 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: type: string enum: - '+' - '-' - '*' - '/' - quotient fields: description: type: array items: type: string ordering: description: |- Arithmetic post-aggregators may specify an ordering, which defines the order of resulting values when sorting results. This can be useful for topN queries for instance. If no ordering (or null) is specified, the default floating point ordering is used. numericFirst 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. 'fieldName' refers to the output name of the aggregator given in the aggregations portion of the query. For complex aggregators, like "cardinality" and "hyperUnique", the type of the post-aggregator determines what the post-aggregator will return. Use type "fieldAccess" to return the raw aggregation object, 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. doubleLeast and longLeast computes the minimum of all fields and Double.POSITIVE_INFINITY. The difference between the doubleMax aggregator and the doubleGreatest post-aggregator is that doubleMax returns the highest value of all rows for one specific column while doubleGreatest returns the highest value of multiple columns in one row. These 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 fields: description: the fields that are used to compute the greatest or least value. type: string telemetry.DruidHyperUniquePostAggregator: description: |- The hyperUniqueCardinality post aggregator is used to wrap a hyperUnique object such that it can be used in post aggregations. This post-aggregator will inherit the rounding behavior of the aggregator it references. Note that this inheritance is only effective if you directly reference an aggregator. Going through another post-aggregator, for example, will cause the user-specified rounding behavior 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 that 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 fields: description: array of fieldAccess type post aggregators to access the thetaSketch aggregators or thetaSketchSetOp type post aggregators to allow arbitrary combination of set operations. type: array items: type: string 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. Can 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. 0 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 a relational database. However, a query can also masquerade as a data source, providing subquery-like functionality. Query data sources are currently supported only 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' 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 to some criteria. Conceptually, they can be thought of as an approximate GroupByQuery over a single dimension with an Ordering spec. TopNs are much faster and resource efficient than GroupBys for this use case. These types of queries take a topN query object and return an array of JSON objects where each object represents a value asked for by the topN query. TopNs are approximate in that each data process will rank their top K results and only return those top K results to the Broker. K, by default in Druid, is max(1000, threshold). In practice, this means that if you ask for the top 1000 items ordered, the correctness of the first ~900 items will be 100%, and the ordering of the results after that is not guaranteed. TopNs 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 a relational database. However, a query can also masquerade as a data source, providing subquery-like functionality. Query data sources are currently supported only 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' 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 where 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 a relational database. However, a query can also masquerade as a data source, providing subquery-like functionality. Query data sources are currently supported only 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' 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. In addition to straightforward usage where a Scan query is issued to the Broker, the Scan query can also be issued directly to Historical processes or streaming ingestion tasks. This can be useful if 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 a relational database. However, a query can also masquerade as a data source, providing subquery-like functionality. Query data sources are currently supported only 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, compactedList or valueVector. Currently only list and compactedList are supported. 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 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' 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. These queries return information about the timestamp of latest ingested event for the dataSource. This 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' 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: - # This 'aaa.AbstractAuditRecord' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'aaa.AbstractAuditRecord' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'aaa.AbstractAuditRecord', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Event: description: |- The operation that was performed on this Managed Object. The 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 x-omitempty: true MoDisplayNames: description: |- The user-friendly names of the changed MO. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true MoType: description: |- The object type of the REST resource that was created, modified or deleted. type: string x-omitempty: true ObjectMoid: description: |- The Moid of the REST resource that was created, modified or deleted. type: string 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. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true TraceId: description: |- The trace id of the request that was used to create, modify or delete a REST resource. A trace id is a unique identifier for one particular REST request. It may be used for troubleshooting purpose by the Intersight technical support team. type: string x-omitempty: true aaa.AuditRecord.Response: description: |- The response body of a HTTP GET request for the 'aaa.AuditRecord' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- AuditRecord presents the configuration changes made by the user per transaction. x-allOf-name: aaa.AuditRecord allOf: - # This 'aaa.AuditRecord' class inherits all properties from its parent class aaa.AbstractAuditRecord. $ref: '#/components/schemas/aaa.AbstractAuditRecord' - # The definition of all the properties specified in this 'aaa.AuditRecord' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'aaa.AuditRecord', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'aaa.AuditRecord' ObjectType: enum: - 'aaa.AuditRecord' 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])?)*$" 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 x-omitempty: true SourceIp: description: |- The source IP of the client. type: string 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 x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Sessions: # A Relationship to MO iam.Session $ref: '#/components/schemas/iam.Session.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSession resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true User: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When 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. The '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 access.Policy.Response: description: |- The response body of a HTTP GET request for the 'access.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'access.Policy' resources. x-one-of-name: access.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/access.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType access.Policy: title: IMC Access Policy description: |- Policy to configure server management options via CIMC. x-allOf-name: access.Policy allOf: - # This 'access.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'access.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'access.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'access.Policy' ObjectType: enum: - 'access.Policy' InbandVlan: description: |- VLAN to be used for server access over Inband network. type: integer format: int64 minimum: 4 maximum: 4093 x-omitempty: true InbandIpPool: # A Relationship to MO ippool.Pool $ref: '#/components/schemas/ippool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. InbandVrf: # A Relationship to MO vrf.Vrf $ref: '#/components/schemas/vrf.Vrf.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vrfVrf resource. When the $expand query parameter is specified, the referenced resource is returned inline. Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true access.Policy.List: title: List of 'access.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'access.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'access.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/access.Policy' nullable: true adapter.AdapterConfig: title: Adapter Configuration description: |- Global adapter level settings. x-allOf-name: adapter.AdapterConfig allOf: - # This 'adapter.AdapterConfig' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'adapter.AdapterConfig' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.AdapterConfig', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.AdapterConfig' ObjectType: enum: - 'adapter.AdapterConfig' DceInterfaceSettings: type: array items: description: |- Collection of DCE interface settings for this adapter. $ref: '#/components/schemas/adapter.DceInterfaceSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 0 maxItems: 4 EthSettings: description: |- Global Ethernet settings for this adapter. $ref: '#/components/schemas/adapter.EthSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true FcSettings: description: |- Global Fibre Channel settings for this adapter. $ref: '#/components/schemas/adapter.FcSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortChannelSettings: description: |- Port Channel settings for this adapter. $ref: '#/components/schemas/adapter.PortChannelSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SlotId: description: |- PCIe slot where the VIC adapter is installed. Supported values are (1-15) and MLOM. type: string pattern: "^([1-9]|1[0-5]|MLOM)$" x-omitempty: true adapter.ConfigPolicy.Response: description: |- The response body of a HTTP GET request for the 'adapter.ConfigPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'adapter.ConfigPolicy' resources. x-one-of-name: adapter.ConfigPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/adapter.ConfigPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType adapter.ConfigPolicy: title: Adapter Configuration description: |- An Adapter Configuration Policy configures the Ethernet and Fibre-Channel settings for the VIC adapter. x-allOf-name: adapter.ConfigPolicy allOf: - # This 'adapter.ConfigPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'adapter.ConfigPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.ConfigPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.ConfigPolicy' ObjectType: enum: - 'adapter.ConfigPolicy' Settings: type: array items: description: |- Configuration for all the adapters available in the server. $ref: '#/components/schemas/adapter.AdapterConfig' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true adapter.ConfigPolicy.List: title: List of 'adapter.ConfigPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'adapter.ConfigPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'adapter.ConfigPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/adapter.ConfigPolicy' nullable: true adapter.DceInterfaceSettings: title: DCE Interface Settings description: |- Settings applicable for the Data Center Ethernet (DCE) interfaces on the adapter card. x-allOf-name: adapter.DceInterfaceSettings allOf: - # This 'adapter.DceInterfaceSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'adapter.DceInterfaceSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.DceInterfaceSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.DceInterfaceSettings' ObjectType: enum: - 'adapter.DceInterfaceSettings' FecMode: description: |- Forward Error Correction (FEC) mode setting for the DCE interfaces of the adapter. FEC mode setting is supported only for Cisco VIC 14xx adapters. FEC mode 'cl74' is unsupported for Cisco VIC 1495/1497. This setting will be ignored for unsupported adapters and for unavailable DCE interfaces. * `Auto` - Use auto-negotiation with peer switch to arrive at common negotiated FEC mode. * `cl91` - Use cl91 standard as FEC mode setting. 'Clause 91' aka RS-FEC ('ReedSolomon' FEC) offers better error protection against bursty and random errors but adds latency. * `cl74` - Use cl74 standard as FEC mode setting. 'Clause 74' aka FC-FEC ('FireCode' FEC) offers simple, low-latency protection against 1 burst/sparse bit error, but it is not good for random errors. * `Off` - Disable FEC mode on the DCE Interface. type: string enum: - 'Auto' - 'cl91' - 'cl74' - 'Off' default: Auto x-omitempty: true InterfaceId: description: |- DCE interface id on which settings needs to be configured. Supported values are (0-3). type: integer format: int64 minimum: 0 maximum: 3 x-omitempty: true adapter.EthSettings: title: Ethernet Settings description: |- Global Ethernet settings for this adapter. x-allOf-name: adapter.EthSettings allOf: - # This 'adapter.EthSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'adapter.EthSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.EthSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.EthSettings' ObjectType: enum: - 'adapter.EthSettings' LldpEnabled: description: |- Status of LLDP protocol on the adapter interfaces. type: boolean x-omitempty: true adapter.ExtEthInterface.Response: description: |- The response body of a HTTP GET request for the 'adapter.ExtEthInterface' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'adapter.ExtEthInterface' resources. x-one-of-name: adapter.ExtEthInterface.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/adapter.ExtEthInterface.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType adapter.ExtEthInterface.Relationship: description: A relationship to the 'adapter.ExtEthInterface' resource, or the expanded 'adapter.ExtEthInterface' resource, or the 'null' value. x-one-of-name: adapter.ExtEthInterface.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/adapter.ExtEthInterface' adapter.ExtEthInterface: title: Adapter:Ext Eth Interface description: |- Physical port of a virtual interface card. x-allOf-name: adapter.ExtEthInterface allOf: - # This 'adapter.ExtEthInterface' class inherits all properties from its parent class port.InterfaceBase. $ref: '#/components/schemas/port.InterfaceBase' - # The definition of all the properties specified in this 'adapter.ExtEthInterface' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.ExtEthInterface', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.ExtEthInterface' ObjectType: enum: - 'adapter.ExtEthInterface' AdminState: description: |- Admin configured state of an External Ethernet Interface. type: string readOnly: true x-omitempty: true EpDn: description: |- Endpoint Config DN of an External Ethernet Interface. type: string readOnly: true x-omitempty: true ExtEthInterfaceId: description: |- Unique Identifier for an External Ethernet Interface within the adapter object. type: string readOnly: true x-omitempty: true InterfaceType: description: |- Type of an External Ethernet Interface. type: string readOnly: true x-omitempty: true MacAddress: description: |- MAC address of an External Ethernet Interface. type: string readOnly: true x-omitempty: true PeerAggrPortId: description: |- Peer Aggregate Port Id attached to an External Ethernet Interface. type: integer format: int64 readOnly: true x-omitempty: true PeerDn: description: |- DN of peer end-point attached to an External Ethernet Interface. type: string readOnly: true x-omitempty: true PeerPortId: description: |- Peer Port Id attached to an External Ethernet Interface. type: integer format: int64 readOnly: true x-omitempty: true PeerSlotId: description: |- Peer Slot Id attached to an External Ethernet Interface. type: integer format: int64 readOnly: true x-omitempty: true SwitchId: description: |- SwitchId attached to an External Ethernet Interface. type: string readOnly: true x-omitempty: true AdapterUnit: # A Relationship to MO adapter.Unit $ref: '#/components/schemas/adapter.Unit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a adapterUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true adapter.ExtEthInterface.List: title: List of 'adapter.ExtEthInterface' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'adapter.ExtEthInterface' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'adapter.ExtEthInterface' resources matching the request. type: array items: $ref: '#/components/schemas/adapter.ExtEthInterface' nullable: true adapter.FcSettings: title: Fibre Channel Settings description: |- Global Fibre Channel settings for this adapter. x-allOf-name: adapter.FcSettings allOf: - # This 'adapter.FcSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'adapter.FcSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.FcSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.FcSettings' ObjectType: enum: - 'adapter.FcSettings' FipEnabled: description: |- Status of FIP protocol on the adapter interfaces. type: boolean x-omitempty: true adapter.HostEthInterface.Response: description: |- The response body of a HTTP GET request for the 'adapter.HostEthInterface' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'adapter.HostEthInterface' resources. x-one-of-name: adapter.HostEthInterface.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/adapter.HostEthInterface.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType adapter.HostEthInterface.Relationship: description: A relationship to the 'adapter.HostEthInterface' resource, or the expanded 'adapter.HostEthInterface' resource, or the 'null' value. x-one-of-name: adapter.HostEthInterface.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/adapter.HostEthInterface' adapter.HostEthInterface: title: Adapter:Host Eth Interface description: |- Physical / Virtual port of an adapter as seen by the host. x-allOf-name: adapter.HostEthInterface allOf: - # This 'adapter.HostEthInterface' class inherits all properties from its parent class port.InterfaceBase. $ref: '#/components/schemas/port.InterfaceBase' - # The definition of all the properties specified in this 'adapter.HostEthInterface' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.HostEthInterface', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.HostEthInterface' ObjectType: enum: - 'adapter.HostEthInterface' AdminState: description: |- Admin state of the Host Ethernet Interface. type: string readOnly: true x-omitempty: true EpDn: description: |- The Endpoint Config Dn of the Host Ethernet Interface. type: string readOnly: true x-omitempty: true HostEthInterfaceId: description: |- Unique Identifier for an Host Ethernet Interface within the adapter object. type: integer format: int64 readOnly: true x-omitempty: true InterfaceType: description: |- Type of External Ethernet Interface. type: string readOnly: true x-omitempty: true MacAddress: description: |- Mac address of the Host Ethernet Interface. type: string readOnly: true x-omitempty: true Name: description: |- Name of Host Ethernet Interface. type: string readOnly: true x-omitempty: true Operability: description: |- Operability status of Host Ethernet Channel Interface. type: string readOnly: true x-omitempty: true OriginalMacAddress: description: |- The factory default Mac address of the Host Ethernet Interface. type: string readOnly: true x-omitempty: true PciAddr: description: |- The PCI address of the Host Ethernet Interface. type: string readOnly: true x-omitempty: true PeerDn: description: |- The distinguished name of the peer endpoint connected to the Host Ethernet interface. type: string readOnly: true x-omitempty: true VirtualizationPreference: description: |- Virtualization Preference of the Host Ethernet Interface indicating if virtualization is enabled or not. type: string readOnly: true x-omitempty: true VnicDn: description: |- The Virtual Ethernet Interface DN connected to the Host Ethernet Interface. type: string readOnly: true x-omitempty: true AdapterUnit: # A Relationship to MO adapter.Unit $ref: '#/components/schemas/adapter.Unit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a adapterUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true adapter.HostEthInterface.List: title: List of 'adapter.HostEthInterface' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'adapter.HostEthInterface' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'adapter.HostEthInterface' resources matching the request. type: array items: $ref: '#/components/schemas/adapter.HostEthInterface' nullable: true adapter.HostFcInterface.Response: description: |- The response body of a HTTP GET request for the 'adapter.HostFcInterface' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'adapter.HostFcInterface' resources. x-one-of-name: adapter.HostFcInterface.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/adapter.HostFcInterface.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType adapter.HostFcInterface.Relationship: description: A relationship to the 'adapter.HostFcInterface' resource, or the expanded 'adapter.HostFcInterface' resource, or the 'null' value. x-one-of-name: adapter.HostFcInterface.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/adapter.HostFcInterface' adapter.HostFcInterface: title: Adapter:Host Fc Interface description: |- Host facing fibre channel interface on a server adapter. x-allOf-name: adapter.HostFcInterface allOf: - # This 'adapter.HostFcInterface' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'adapter.HostFcInterface' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.HostFcInterface', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.HostFcInterface' ObjectType: enum: - 'adapter.HostFcInterface' AdminState: description: |- Admin Configured State of Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true EpDn: description: |- The Endpoint Config Dn of the Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true HostFcInterfaceId: description: |- Identifier of Host Fibre Channel Interface. type: integer format: int64 readOnly: true x-omitempty: true Name: description: |- Name of Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true OperState: description: |- Operational State of Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true Operability: description: |- Operability status of Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true OriginalWwnn: description: |- The uniquely distinguishable factory default World Wide Node Name of the Host. type: string readOnly: true x-omitempty: true OriginalWwpn: description: |- The uniquely distinguishable factory default World Wide Port Name of the Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true PeerDn: description: |- PeerPort Dn of Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true Wwnn: description: |- The uniquely distinguishable user configured World Wide Node Name of the Host. type: string readOnly: true x-omitempty: true Wwpn: description: |- The uniquely distinguishable user configured World Wide Port Name of the Host Fibre Channel Interface. type: string readOnly: true x-omitempty: true AdapterUnit: # A Relationship to MO adapter.Unit $ref: '#/components/schemas/adapter.Unit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a adapterUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true adapter.HostFcInterface.List: title: List of 'adapter.HostFcInterface' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'adapter.HostFcInterface' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'adapter.HostFcInterface' resources matching the request. type: array items: $ref: '#/components/schemas/adapter.HostFcInterface' nullable: true adapter.HostIscsiInterface.Response: description: |- The response body of a HTTP GET request for the 'adapter.HostIscsiInterface' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'adapter.HostIscsiInterface' resources. x-one-of-name: adapter.HostIscsiInterface.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/adapter.HostIscsiInterface.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType adapter.HostIscsiInterface.Relationship: description: A relationship to the 'adapter.HostIscsiInterface' resource, or the expanded 'adapter.HostIscsiInterface' resource, or the 'null' value. x-one-of-name: adapter.HostIscsiInterface.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/adapter.HostIscsiInterface' adapter.HostIscsiInterface: title: Adapter:Host Iscsi Interface description: |- Iscsi interface on a server adapter. x-allOf-name: adapter.HostIscsiInterface allOf: - # This 'adapter.HostIscsiInterface' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'adapter.HostIscsiInterface' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.HostIscsiInterface', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.HostIscsiInterface' ObjectType: enum: - 'adapter.HostIscsiInterface' AdminState: description: |- Admin Configured State of Host ISCSI Interface. type: string readOnly: true x-omitempty: true EpDn: description: |- The Endpoint Config Dn of the Host ISCSI Interface. type: string readOnly: true x-omitempty: true HostIscsiInterfaceId: description: |- Identifier of the Host ISCSI Interface. type: integer format: int64 readOnly: true x-omitempty: true HostVisible: description: |- The visibility of the Host to the endpoint. type: string readOnly: true x-omitempty: true MacAddress: description: |- MAC address of Host ISCSI Interface. type: string readOnly: true x-omitempty: true Name: description: |- Name of the Host ISCSI Interface. type: string readOnly: true x-omitempty: true OperState: description: |- Operational State of Host ISCSI Interface. type: string readOnly: true x-omitempty: true Operability: description: |- Operability status of Host ISCSI Interface. type: string readOnly: true x-omitempty: true PeerDn: description: |- PeerPort Dn of Host ISCSI Interface. type: string readOnly: true x-omitempty: true AdapterUnit: # A Relationship to MO adapter.Unit $ref: '#/components/schemas/adapter.Unit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a adapterUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true adapter.HostIscsiInterface.List: title: List of 'adapter.HostIscsiInterface' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'adapter.HostIscsiInterface' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'adapter.HostIscsiInterface' resources matching the request. type: array items: $ref: '#/components/schemas/adapter.HostIscsiInterface' nullable: true adapter.PortChannelSettings: title: Port Channel Settings description: |- Port Channel setting for this adapter. x-allOf-name: adapter.PortChannelSettings allOf: - # This 'adapter.PortChannelSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'adapter.PortChannelSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.PortChannelSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.PortChannelSettings' ObjectType: enum: - 'adapter.PortChannelSettings' Enabled: description: |- When Port Channel is enabled, two vNICs and two vHBAs are available for use on the adapter card. When disabled, four vNICs and four vHBAs are available for use on the adapter card. Disabling port channel reboots the server. Port Channel is supported only for Cisco VIC 1455/1457 adapters. type: boolean x-omitempty: true adapter.Unit.Response: description: |- The response body of a HTTP GET request for the 'adapter.Unit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'adapter.Unit' resources. x-one-of-name: adapter.Unit.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/adapter.Unit.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType adapter.Unit.Relationship: description: A relationship to the 'adapter.Unit' resource, or the expanded 'adapter.Unit' resource, or the 'null' value. x-one-of-name: adapter.Unit.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/adapter.Unit' adapter.Unit: title: Adapter:Unit description: |- The physical adapter present on a server. x-allOf-name: adapter.Unit allOf: - # This 'adapter.Unit' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'adapter.Unit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'adapter.Unit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'adapter.Unit' ObjectType: enum: - 'adapter.Unit' AdapterId: description: |- Unique Identifier of an adapter Unit within a Rack Interface. type: string readOnly: true x-omitempty: true BaseMacAddress: description: |- Original Base Mac address of an adapter unit. type: string readOnly: true x-omitempty: true ConnectionStatus: description: |- Connectivity Status of adapter - A or B or AB. type: string readOnly: true x-omitempty: true Integrated: description: |- Cisco Integrated adapter or other type. type: string readOnly: true x-omitempty: true OperState: description: |- Operational state of an adapter unit. type: string readOnly: true x-omitempty: true Operability: description: |- Operability state of an adapter unit. type: string readOnly: true x-omitempty: true PartNumber: description: |- Part number of an adapter unit. type: string readOnly: true x-omitempty: true PciSlot: description: |- PCIe slot of the adapter in the server. type: string readOnly: true x-omitempty: true Power: description: |- Power state of an adapter unit. type: string readOnly: true x-omitempty: true Presence: description: |- Adapter Unit presence or absence. type: string readOnly: true x-omitempty: true Thermal: description: |- Thermal state of an adapter unit. type: string readOnly: true x-omitempty: true Vid: description: |- Virtual Id of the adapter in the server. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Controller: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ExtEthIfs: # A Relationship to MO adapter.ExtEthInterface description: An array of relationships to adapterExtEthInterface resources. type: array items: $ref: '#/components/schemas/adapter.ExtEthInterface.Relationship' nullable: true readOnly: true HostEthIfs: # A Relationship to MO adapter.HostEthInterface description: An array of relationships to adapterHostEthInterface resources. type: array items: $ref: '#/components/schemas/adapter.HostEthInterface.Relationship' nullable: true readOnly: true HostFcIfs: # A Relationship to MO adapter.HostFcInterface description: An array of relationships to adapterHostFcInterface resources. type: array items: $ref: '#/components/schemas/adapter.HostFcInterface.Relationship' nullable: true readOnly: true HostIscsiIfs: # A Relationship to MO adapter.HostIscsiInterface description: An array of relationships to adapterHostIscsiInterface resources. type: array items: $ref: '#/components/schemas/adapter.HostIscsiInterface.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true adapter.Unit.List: title: List of 'adapter.Unit' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'adapter.Unit' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'adapter.Unit' resources matching the request. type: array items: $ref: '#/components/schemas/adapter.Unit' nullable: true appliance.Backup.Response: description: |- The response body of a HTTP GET request for the 'appliance.Backup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: title: Appliance:Backup description: |- Backup tracks all backup requests to create a full system backup of the Intersight Appliance. There will be only one Backup managed object with a 'Started' state at any time. All other Backup managed objects will be in terminal states. x-allOf-name: appliance.Backup allOf: - # This 'appliance.Backup' class inherits all properties from its parent class appliance.BackupBase. $ref: '#/components/schemas/appliance.BackupBase' - # The definition of all the properties specified in this 'appliance.Backup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.Backup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.Backup' ObjectType: enum: - 'appliance.Backup' 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 IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Messages: type: array items: description: |- Messages generated during the backup process. type: string readOnly: true x-omitempty: true Password: description: |- Password to authenticate the fileserver. type: string 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. * `Started` - Backup or restore process has started. * `Created` - Backup or restore is in created state. * `Failed` - Backup or restore process has failed. * `Completed` - Backup or restore process has completed. * `Copied` - Backup file has been copied. type: string enum: - 'Started' - 'Created' - 'Failed' - 'Completed' - 'Copied' default: Started readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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. BackupBase holds the common information required for copying the file from the Intersight Appliance to the remote file server and vice versa. x-allOf-name: appliance.BackupBase allOf: - # This 'appliance.BackupBase' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.BackupBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.BackupBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Filename: description: |- Backup filename to backup or restore. type: string x-omitempty: true Protocol: description: |- Communication protocol used by the file server (e.g. scp or sftp). * `scp` - Secure Copy Protocol (SCP) to access the file server. * `sftp` - SSH File Transfer Protocol (SFTP) to access file server. type: string enum: - 'scp' - 'sftp' default: scp x-omitempty: true RemoteHost: description: |- Hostname of the remote file server. type: string x-omitempty: true RemotePath: description: |- File server directory to copy the file. type: string x-omitempty: true RemotePort: description: |- Remote TCP port on the file server (e.g. 22 for scp). type: integer format: int64 x-omitempty: true Username: description: |- Username to authenticate the fileserver. type: string x-omitempty: true appliance.BackupPolicy.Response: description: |- The response body of a HTTP GET request for the 'appliance.BackupPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- BackupPolicy stores the Intersight Appliance's backup policy. There will be only one BackupPolicy managed object in the Intersight Appliance. Default backup policy managed object is created during the Intersight Appliance setup, and it is configured in the manual backup mode. x-allOf-name: appliance.BackupPolicy allOf: - # This 'appliance.BackupPolicy' class inherits all properties from its parent class appliance.BackupBase. $ref: '#/components/schemas/appliance.BackupBase' - # The definition of all the properties specified in this 'appliance.BackupPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.BackupPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.BackupPolicy' ObjectType: enum: - 'appliance.BackupPolicy' 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 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 writeOnly: true 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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.CertificateSetting.Response: description: |- The response body of a HTTP GET request for the 'appliance.CertificateSetting' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Certificate the appliance uses for browser traffic. x-allOf-name: appliance.CertificateSetting allOf: - # This 'appliance.CertificateSetting' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.CertificateSetting' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.CertificateSetting', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.CertificateSetting' ObjectType: enum: - 'appliance.CertificateSetting' Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Certificate: # A Relationship to MO iam.Certificate $ref: '#/components/schemas/iam.Certificate.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamCertificate resource. When 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. The '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.DataExportPolicy.Response: description: |- The response body of a HTTP GET request for the 'appliance.DataExportPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' appliance.DataExportPolicy: title: Appliance:Data Export Policy description: |- Data Export Policy is a category-based data collection policy that enables or disables data export (data collection) from the Intersight Appliance to the Intersight. The Data Export Policy configuration is organized hierarchically as follows. Global: Inventory: Network Storage TechSupport When the DataExportPolicy for a category is enabled/disabled, all the sub-category configurations are enabled/disabled as well. For example, if you enable/disable Inventory, all its sub-category configurations (ie. Network and Storage) are also enabled/disabled. x-allOf-name: appliance.DataExportPolicy allOf: - # This 'appliance.DataExportPolicy' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.DataExportPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.DataExportPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.DataExportPolicy' ObjectType: enum: - 'appliance.DataExportPolicy' 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. ParentConfig: # A Relationship to MO appliance.DataExportPolicy $ref: '#/components/schemas/appliance.DataExportPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a applianceDataExportPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true SubConfigs: # A Relationship to MO appliance.DataExportPolicy 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. The '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.DeviceClaim.Response: description: |- The response body of a HTTP GET request for the 'appliance.DeviceClaim' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- DeviceClaim managed object represents a user initiated claim request for claiming an endpoint device. There can be many DeviceClaim managed object for a given endpoint device when users claim and unclaim devices repeatedly. Claiming an endpoint device is a multi-step operation. The Intersight Appliance starts a workflow with multiple tasks to process the device claim request. The status of the device claim operation can be obtained from the claim workflow. x-allOf-name: appliance.DeviceClaim allOf: - # This 'appliance.DeviceClaim' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.DeviceClaim' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.DeviceClaim', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.DeviceClaim' ObjectType: enum: - 'appliance.DeviceClaim' 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 readOnly: true 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. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' 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. * `started` - Device claim operation has started. * `failed` - Device claim operation has failed. * `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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: 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. The '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.DiagSetting.Response: description: |- The response body of a HTTP GET request for the 'appliance.DiagSetting' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- DiagSetting model is used for changing the password of the operating system's diagnostic user account. The diagnostic user account can be used to login to the Intersight Appliance virtual machine. The diagnostic user account is protected by two separate authentication mechanisms: user's password and Cisco CT-engine generated key. Only the Intersight Appliance's local account administrator has the privileges to use this REST API. x-allOf-name: appliance.DiagSetting allOf: - # This 'appliance.DiagSetting' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.DiagSetting' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.DiagSetting', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.DiagSetting' ObjectType: enum: - 'appliance.DiagSetting' IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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.ImageBundle.Response: description: |- The response body of a HTTP GET request for the 'appliance.ImageBundle' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' appliance.ImageBundle: title: Appliance:Image Bundle description: |- ImageBundle keeps track of all the software bundles installed in the Intersight Appliances. Each ImageBundle managed object is derived from a software upgrade manifest. ImageBundle has additional properties computed during the manifest processing. Additional properties are the dynamic attributes of the software packages declared in the software manifest. For example, SHA256 values of the software packages are computed during the software manifest processing. An ImageBundle managed object named 'current' is always present in the Intersight Appliance. The software upgrade service creates another ImageBundle managed object named 'pending' when there is a pending software upgrade. The upgrade service renames the 'pending' bundle to the 'current' bundle after the software upgrade is successful. x-allOf-name: appliance.ImageBundle allOf: - # This 'appliance.ImageBundle' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.ImageBundle' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.ImageBundle', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.ImageBundle' ObjectType: enum: - 'appliance.ImageBundle' AnsiblePackages: type: array items: description: |- Collection of the Intersight Appliance's system installation packages. $ref: '#/components/schemas/onprem.ImagePackage' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true InitPackages: type: array items: description: |- Collection of the Intersight Appliance's initialization service packages. $ref: '#/components/schemas/onprem.ImagePackage' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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. * `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. * `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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true UiPackages: type: array items: description: |- Collection of the Intersight Appliance's UI packages of the micro-services. $ref: '#/components/schemas/onprem.ImagePackage' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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 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. * `None` - The upgrade has no effect on the system. * `Disruptive` - The services will not be functional during the upgrade. * `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 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. The '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 allOf: - # This 'appliance.KeyValuePair' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'appliance.KeyValuePair' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.KeyValuePair', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.KeyValuePair' ObjectType: enum: - 'appliance.KeyValuePair' 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.NodeInfo.Response: description: |- The response body of a HTTP GET request for the 'appliance.NodeInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: title: Appliance:Node Info description: |- NodeInfo managed object stores the Intersight Appliance's cluster node information. NodeInfo managed objects are created during the Intersight Appliance setup. The Intersight Appliance updates the NodeInfo managed objects with status information periodically. x-allOf-name: appliance.NodeInfo allOf: - # This 'appliance.NodeInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.NodeInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.NodeInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.NodeInfo' ObjectType: enum: - 'appliance.NodeInfo' 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: '#/components/schemas/comm.IpV4Interface' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true OperationalStatus: description: |- Operational status of the Intersight Appliance node. * `Unknown` - Operational status of the Intersight Appliance entity is Unknown. * `Operational` - Operational status of the Intersight Appliance entity is Operational. * `Impaired` - Operational status of the Intersight Appliance entity is Impaired. * `AttentionNeeded` - Operational status of the Intersight Appliance entity is AttentionNeeded. type: string enum: - 'Unknown' - 'Operational' - 'Impaired' - 'AttentionNeeded' 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. The '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.ReleaseNote.Response: description: |- The response body of a HTTP GET request for the 'appliance.ReleaseNote' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'appliance.ReleaseNote' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.ReleaseNote' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.ReleaseNote', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.ReleaseNote' ObjectType: enum: - 'appliance.ReleaseNote' Notes: type: array items: description: |- Notes list all the upgrade notes for one upgrade. $ref: '#/components/schemas/onprem.UpgradeNote' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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. The '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.Restore.Response: description: |- The response body of a HTTP GET request for the 'appliance.Restore' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Restore tracks requests to restore the Intersight Appliance. There will be only one Restore managed object with a 'Started' state at any time. All other Restore managed objects will be in terminal states. x-allOf-name: appliance.Restore allOf: - # This 'appliance.Restore' class inherits all properties from its parent class appliance.BackupBase. $ref: '#/components/schemas/appliance.BackupBase' - # The definition of all the properties specified in this 'appliance.Restore' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.Restore', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.Restore' ObjectType: enum: - 'appliance.Restore' 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 readOnly: true x-omitempty: true Messages: type: array items: description: |- Messages generated during the restore process. type: string x-omitempty: true Password: description: |- Password for authenticating with the file server. type: string 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. * `Started` - Backup or restore process has started. * `Created` - Backup or restore is in created state. * `Failed` - Backup or restore process has failed. * `Completed` - Backup or restore process has completed. * `Copied` - Backup file has been copied. type: string enum: - 'Started' - 'Created' - 'Failed' - 'Completed' - 'Copied' default: Started readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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 track of the Intersight Appliance's setup information and guide the UI through the initial configuration of the Intersight Appliance. The SetupInfo managed object is created during the Intersight Appliance setup. The Intersight UI uses this object to store the initial configuration states that the user has completed. If the user closes the Intersight UI without finishing all the initial configuration, then the Intersight UI will use this managed object to display the next configuration that the user needs to complete when the user uses the Intersight Appliance next time. x-allOf-name: appliance.SetupInfo allOf: - # This 'appliance.SetupInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.SetupInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.SetupInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.SetupInfo' ObjectType: enum: - 'appliance.SetupInfo' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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. In connected mode, Intersight Appliance is claimed by Intesight SaaS. In air-gapped mode, Intersight Appliance does not connect to any Cisco services. * `Connected` - In connected mode, Intersight Appliance connects to Intersight SaaS and other cisco.com services. * `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 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 StartTime: description: |- Start date of the Intersight Appliance's initial setup. type: string format: date-time readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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.SystemInfo.Response: description: |- The response body of a HTTP GET request for the 'appliance.SystemInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: title: Appliance:System Info description: |- The Intersight Appliance's system information. SystemInfo is a singleton managed object created during the Intersight Appliance setup. The Intersight Appliance updates the SystemInfo managed object with up to date cluster status information periodically. x-allOf-name: appliance.SystemInfo allOf: - # This 'appliance.SystemInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.SystemInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.SystemInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.SystemInfo' ObjectType: enum: - 'appliance.SystemInfo' CloudConnStatus: description: |- Connection state of the Intersight Appliance to the Intersight. * `` - The device registered with Intersight but subsequently did not establish a persistent websocket connection. * `Connected` - The device's connection to Intersight has been established and is active. * `NotConnected` - The device's connection to Intersight has been disconnected. * `ClaimInProgress` - Claim of the device is in progress. * `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. type: string enum: - '' - 'Connected' - 'NotConnected' - 'ClaimInProgress' - 'Unclaimed' default: "" 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 or IP address 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 OperationalStatus: description: |- Operational status of the Intersight Appliance cluster. * `Unknown` - Operational status of the Intersight Appliance entity is Unknown. * `Operational` - Operational status of the Intersight Appliance entity is Operational. * `Impaired` - Operational status of the Intersight Appliance entity is Impaired. * `AttentionNeeded` - Operational status of the Intersight Appliance entity is AttentionNeeded. type: string enum: - 'Unknown' - 'Operational' - 'Impaired' - 'AttentionNeeded' 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* `Pacific/Pago_Pago` - \n* `Pacific/Honolulu` - \n* `Pacific/Rarotonga` - \n* `Pacific/Tahiti` - \n* `Pacific/Marquesas` - \n* `America/Anchorage` - \n* `Pacific/Gambier` - \n* `America/Los_Angeles` - \n* `America/Tijuana` - \n* `America/Vancouver` - \n* `America/Whitehorse` - \n* `Pacific/Pitcairn` - \n* `America/Dawson_Creek` - \n* `America/Denver` - \n* `America/Edmonton` - \n* `America/Hermosillo` - \n* `America/Mazatlan` - \n* `America/Phoenix` - \n* `America/Yellowknife` - \n* `America/Belize` - \n* `America/Chicago` - \n* `America/Costa_Rica` - \n* `America/El_Salvador` - \n* `America/Guatemala` - \n* `America/Managua` - \n* `America/Mexico_City` - \n* `America/Regina` - \n* `America/Tegucigalpa` - \n* `America/Winnipeg` - \n* `Pacific/Galapagos` - \n* `America/Bogota` - \n* `America/Cancun` - \n* `America/Cayman` - \n* `America/Guayaquil` - \n* `America/Havana` - \n* `America/Iqaluit` - \n* `America/Jamaica` - \n* `America/Lima` - \n* `America/Nassau` - \n* `America/New_York` - \n* `America/Panama` - \n* `America/Port-au-Prince` - \n* `America/Rio_Branco` - \n* `America/Toronto` - \n* `Pacific/Easter` - \n* `America/Caracas` - \n* `America/Asuncion` - \n* `America/Barbados` - \n* `America/Boa_Vista` - \n* `America/Campo_Grande` - \n* `America/Cuiaba` - \n* `America/Curacao` - \n* `America/Grand_Turk` - \n* `America/Guyana` - \n* `America/Halifax` - \n* `America/La_Paz` - \n* `America/Manaus` - \n* `America/Martinique` - \n* `America/Port_of_Spain` - \n* `America/Porto_Velho` - \n* `America/Puerto_Rico` - \n* `America/Santo_Domingo` - \n* `America/Thule` - \n* `Atlantic/Bermuda` - \n* `America/St_Johns` - \n* `America/Araguaina` - \n* `America/Argentina/Buenos_Aires` - \n* `America/Bahia` - \n* `America/Belem` - \n* `America/Cayenne` - \n* `America/Fortaleza` - \n* `America/Godthab` - \n* `America/Maceio` - \n* `America/Miquelon` - \n* `America/Montevideo` - \n* `America/Paramaribo` - \n* `America/Recife` - \n* `America/Santiago` - \n* `America/Sao_Paulo` - \n* `Antarctica/Palmer` - \n* `Antarctica/Rothera` - \n* `Atlantic/Stanley` - \n* `America/Noronha` - \n* `Atlantic/South_Georgia` - \n* `America/Scoresbysund` - \n* `Atlantic/Azores` - \n* `Atlantic/Cape_Verde` - \n* `Africa/Abidjan` - \n* `Africa/Accra` - \n* `Africa/Bissau` - \n* `Africa/Casablanca` - \n* `Africa/El_Aaiun` - \n* `Africa/Monrovia` - \n* `America/Danmarkshavn` - \n* `Atlantic/Canary` - \n* `Atlantic/Faroe` - \n* `Atlantic/Reykjavik` - \n* `Etc/GMT` - \n* `Europe/Dublin` - \n* `Europe/Lisbon` - \n* `Europe/London` - \n* `Africa/Algiers` - \n* `Africa/Ceuta` - \n* `Africa/Lagos` - \n* `Africa/Ndjamena` - \n* `Africa/Tunis` - \n* `Africa/Windhoek` - \n* `Europe/Amsterdam` - \n* `Europe/Andorra` - \n* `Europe/Belgrade` - \n* `Europe/Berlin` - \n* `Europe/Brussels` - \n* `Europe/Budapest` - \n* `Europe/Copenhagen` - \n* `Europe/Gibraltar` - \n* `Europe/Luxembourg` - \n* `Europe/Madrid` - \n* `Europe/Malta` - \n* `Europe/Monaco` - \n* `Europe/Oslo` - \n* `Europe/Paris` - \n* `Europe/Prague` - \n* `Europe/Rome` - \n* `Europe/Stockholm` - \n* `Europe/Tirane` - \n* `Europe/Vienna` - \n* `Europe/Warsaw` - \n* `Europe/Zurich` - \n* `Africa/Cairo` - \n* `Africa/Johannesburg` - \n* `Africa/Maputo` - \n* `Africa/Tripoli` - \n* `Asia/Amman` - \n* `Asia/Beirut` - \n* `Asia/Damascus` - \n* `Asia/Gaza` - \n* `Asia/Jerusalem` - \n* `Asia/Nicosia` - \n* `Europe/Athens` - \n* `Europe/Bucharest` - \n* `Europe/Chisinau` - \n* `Europe/Helsinki` - \n* `Europe/Istanbul` - \n* `Europe/Kaliningrad` - \n* `Europe/Kiev` - \n* `Europe/Riga` - \n* `Europe/Sofia` - \n* `Europe/Tallinn` - \n* `Europe/Vilnius` - \n* `Africa/Khartoum` - \n* `Africa/Nairobi` - \n* `Antarctica/Syowa` - \n* `Asia/Baghdad` - \n* `Asia/Qatar` - \n* `Asia/Riyadh` - \n* `Europe/Minsk` - \n* `Europe/Moscow` - \n* `Asia/Tehran` - \n* `Asia/Baku` - \n* `Asia/Dubai` - \n* `Asia/Tbilisi` - \n* `Asia/Yerevan` - \n* `Europe/Samara` - \n* `Indian/Mahe` - \n* `Indian/Mauritius` - \n* `Indian/Reunion` - \n* `Asia/Kabul` - \n* `Antarctica/Mawson` - \n* `Asia/Aqtau` - \n* `Asia/Aqtobe` - \n* `Asia/Ashgabat` - \n* `Asia/Dushanbe` - \n* `Asia/Karachi` - \n* `Asia/Tashkent` - \n* `Asia/Yekaterinburg` - \n* `Indian/Kerguelen` - \n* `Indian/Maldives` - \n* `Asia/Calcutta` - \n* `Asia/Kolkata` - \n* `Asia/Colombo` - \n* `Asia/Katmandu` - \n* `Antarctica/Vostok` - \n* `Asia/Almaty` - \n* `Asia/Bishkek` - \n* `Asia/Dhaka` - \n* `Asia/Omsk` - \n* `Asia/Thimphu` - \n* `Indian/Chagos` - \n* `Asia/Rangoon` - \n* `Indian/Cocos` - \n* `Antarctica/Davis` - \n* `Asia/Bangkok` - \n* `Asia/Hovd` - \n* `Asia/Jakarta` - \n* `Asia/Krasnoyarsk` - \n* `Asia/Saigon` - \n* `Indian/Christmas` - \n* `Antarctica/Casey` - \n* `Asia/Brunei` - \n* `Asia/Choibalsan` - \n* `Asia/Hong_Kong` - \n* `Asia/Irkutsk` - \n* `Asia/Kuala_Lumpur` - \n* `Asia/Macau` - \n* `Asia/Makassar` - \n* `Asia/Manila` - \n* `Asia/Shanghai` - \n* `Asia/Singapore` - \n* `Asia/Taipei` - \n* `Asia/Ulaanbaatar` - \n* `Australia/Perth` - \n* `Asia/Pyongyang` - \n* `Asia/Dili` - \n* `Asia/Jayapura` - \n* `Asia/Seoul` - \n* `Asia/Tokyo` - \n* `Asia/Yakutsk` - \n* `Pacific/Palau` - \n* `Australia/Adelaide` - \n* `Australia/Darwin` - \n* `Antarctica/DumontDUrville` - \n* `Asia/Magadan` - \n* `Asia/Vladivostok` - \n* `Australia/Brisbane` - \n* `Australia/Hobart` - \n* `Australia/Sydney` - \n* `Pacific/Chuuk` - \n* `Pacific/Guam` - \n* `Pacific/Port_Moresby` - \n* `Pacific/Efate` - \n* `Pacific/Guadalcanal` - \n* `Pacific/Kosrae` - \n* `Pacific/Norfolk` - \n* `Pacific/Noumea` - \n* `Pacific/Pohnpei` - \n* `Asia/Kamchatka` - \n* `Pacific/Auckland` - \n* `Pacific/Fiji` - \n* `Pacific/Funafuti` - \n* `Pacific/Kwajalein` - \n* `Pacific/Majuro` - \n* `Pacific/Nauru` - \n* `Pacific/Tarawa` - \n* `Pacific/Wake` - \n* `Pacific/Wallis` - \n* `Pacific/Apia` - \n* `Pacific/Enderbury` - \n* `Pacific/Fakaofo` - \n* `Pacific/Tongatapu` - \n* `Pacific/Kiritimati` -" type: string enum: - 'Pacific/Niue' - 'Pacific/Pago_Pago' - 'Pacific/Honolulu' - 'Pacific/Rarotonga' - 'Pacific/Tahiti' - 'Pacific/Marquesas' - 'America/Anchorage' - 'Pacific/Gambier' - 'America/Los_Angeles' - 'America/Tijuana' - 'America/Vancouver' - 'America/Whitehorse' - 'Pacific/Pitcairn' - 'America/Dawson_Creek' - 'America/Denver' - 'America/Edmonton' - 'America/Hermosillo' - 'America/Mazatlan' - 'America/Phoenix' - 'America/Yellowknife' - 'America/Belize' - 'America/Chicago' - 'America/Costa_Rica' - 'America/El_Salvador' - 'America/Guatemala' - 'America/Managua' - 'America/Mexico_City' - 'America/Regina' - 'America/Tegucigalpa' - 'America/Winnipeg' - 'Pacific/Galapagos' - 'America/Bogota' - 'America/Cancun' - 'America/Cayman' - 'America/Guayaquil' - 'America/Havana' - 'America/Iqaluit' - 'America/Jamaica' - 'America/Lima' - 'America/Nassau' - 'America/New_York' - 'America/Panama' - 'America/Port-au-Prince' - 'America/Rio_Branco' - 'America/Toronto' - 'Pacific/Easter' - 'America/Caracas' - 'America/Asuncion' - 'America/Barbados' - 'America/Boa_Vista' - 'America/Campo_Grande' - 'America/Cuiaba' - 'America/Curacao' - 'America/Grand_Turk' - 'America/Guyana' - 'America/Halifax' - 'America/La_Paz' - 'America/Manaus' - 'America/Martinique' - 'America/Port_of_Spain' - 'America/Porto_Velho' - 'America/Puerto_Rico' - 'America/Santo_Domingo' - 'America/Thule' - 'Atlantic/Bermuda' - 'America/St_Johns' - 'America/Araguaina' - 'America/Argentina/Buenos_Aires' - 'America/Bahia' - 'America/Belem' - 'America/Cayenne' - 'America/Fortaleza' - 'America/Godthab' - 'America/Maceio' - 'America/Miquelon' - 'America/Montevideo' - 'America/Paramaribo' - 'America/Recife' - 'America/Santiago' - 'America/Sao_Paulo' - 'Antarctica/Palmer' - 'Antarctica/Rothera' - 'Atlantic/Stanley' - 'America/Noronha' - 'Atlantic/South_Georgia' - 'America/Scoresbysund' - 'Atlantic/Azores' - 'Atlantic/Cape_Verde' - 'Africa/Abidjan' - 'Africa/Accra' - 'Africa/Bissau' - 'Africa/Casablanca' - 'Africa/El_Aaiun' - 'Africa/Monrovia' - 'America/Danmarkshavn' - 'Atlantic/Canary' - 'Atlantic/Faroe' - 'Atlantic/Reykjavik' - 'Etc/GMT' - 'Europe/Dublin' - 'Europe/Lisbon' - 'Europe/London' - 'Africa/Algiers' - 'Africa/Ceuta' - 'Africa/Lagos' - 'Africa/Ndjamena' - 'Africa/Tunis' - 'Africa/Windhoek' - 'Europe/Amsterdam' - 'Europe/Andorra' - 'Europe/Belgrade' - 'Europe/Berlin' - 'Europe/Brussels' - 'Europe/Budapest' - 'Europe/Copenhagen' - 'Europe/Gibraltar' - 'Europe/Luxembourg' - 'Europe/Madrid' - 'Europe/Malta' - 'Europe/Monaco' - 'Europe/Oslo' - 'Europe/Paris' - 'Europe/Prague' - 'Europe/Rome' - 'Europe/Stockholm' - 'Europe/Tirane' - 'Europe/Vienna' - 'Europe/Warsaw' - 'Europe/Zurich' - 'Africa/Cairo' - 'Africa/Johannesburg' - 'Africa/Maputo' - 'Africa/Tripoli' - 'Asia/Amman' - 'Asia/Beirut' - 'Asia/Damascus' - 'Asia/Gaza' - 'Asia/Jerusalem' - 'Asia/Nicosia' - 'Europe/Athens' - 'Europe/Bucharest' - 'Europe/Chisinau' - 'Europe/Helsinki' - 'Europe/Istanbul' - 'Europe/Kaliningrad' - 'Europe/Kiev' - 'Europe/Riga' - 'Europe/Sofia' - 'Europe/Tallinn' - 'Europe/Vilnius' - 'Africa/Khartoum' - 'Africa/Nairobi' - 'Antarctica/Syowa' - 'Asia/Baghdad' - 'Asia/Qatar' - 'Asia/Riyadh' - 'Europe/Minsk' - 'Europe/Moscow' - 'Asia/Tehran' - 'Asia/Baku' - 'Asia/Dubai' - 'Asia/Tbilisi' - 'Asia/Yerevan' - 'Europe/Samara' - 'Indian/Mahe' - 'Indian/Mauritius' - 'Indian/Reunion' - 'Asia/Kabul' - 'Antarctica/Mawson' - 'Asia/Aqtau' - 'Asia/Aqtobe' - 'Asia/Ashgabat' - 'Asia/Dushanbe' - 'Asia/Karachi' - 'Asia/Tashkent' - 'Asia/Yekaterinburg' - 'Indian/Kerguelen' - 'Indian/Maldives' - 'Asia/Calcutta' - 'Asia/Kolkata' - 'Asia/Colombo' - 'Asia/Katmandu' - 'Antarctica/Vostok' - 'Asia/Almaty' - 'Asia/Bishkek' - 'Asia/Dhaka' - 'Asia/Omsk' - 'Asia/Thimphu' - 'Indian/Chagos' - 'Asia/Rangoon' - 'Indian/Cocos' - 'Antarctica/Davis' - 'Asia/Bangkok' - 'Asia/Hovd' - 'Asia/Jakarta' - 'Asia/Krasnoyarsk' - 'Asia/Saigon' - 'Indian/Christmas' - 'Antarctica/Casey' - 'Asia/Brunei' - 'Asia/Choibalsan' - 'Asia/Hong_Kong' - 'Asia/Irkutsk' - 'Asia/Kuala_Lumpur' - 'Asia/Macau' - 'Asia/Makassar' - 'Asia/Manila' - 'Asia/Shanghai' - 'Asia/Singapore' - 'Asia/Taipei' - 'Asia/Ulaanbaatar' - 'Australia/Perth' - 'Asia/Pyongyang' - 'Asia/Dili' - 'Asia/Jayapura' - 'Asia/Seoul' - 'Asia/Tokyo' - 'Asia/Yakutsk' - 'Pacific/Palau' - 'Australia/Adelaide' - 'Australia/Darwin' - 'Antarctica/DumontDUrville' - 'Asia/Magadan' - 'Asia/Vladivostok' - 'Australia/Brisbane' - 'Australia/Hobart' - 'Australia/Sydney' - 'Pacific/Chuuk' - 'Pacific/Guam' - 'Pacific/Port_Moresby' - 'Pacific/Efate' - 'Pacific/Guadalcanal' - 'Pacific/Kosrae' - 'Pacific/Norfolk' - 'Pacific/Noumea' - 'Pacific/Pohnpei' - 'Asia/Kamchatka' - 'Pacific/Auckland' - 'Pacific/Fiji' - 'Pacific/Funafuti' - 'Pacific/Kwajalein' - 'Pacific/Majuro' - 'Pacific/Nauru' - 'Pacific/Tarawa' - 'Pacific/Wake' - 'Pacific/Wallis' - 'Pacific/Apia' - 'Pacific/Enderbury' - 'Pacific/Fakaofo' - 'Pacific/Tongatapu' - 'Pacific/Kiritimati' 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. The '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.Upgrade.Response: description: |- The response body of a HTTP GET request for the 'appliance.Upgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: title: Appliance:Upgrade description: |- Upgrade tracks the Intersight Appliance's software upgrades. Intersight Appliance's upgrade service automatically creates an Upgrade managed object when there is a pending software upgrade. User may modify an active Upgrade managed object to reset the software upgrade start time. However, user may not be able to postpone an upgrade beyond the limit enforced by the upgrade grace period set in the software manifest. x-allOf-name: appliance.Upgrade allOf: - # This 'appliance.Upgrade' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.Upgrade' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.Upgrade', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.Upgrade' ObjectType: enum: - 'appliance.Upgrade' Active: description: |- Indicates if the software upgrade is active or not. 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true CurrentPhase: description: |- Current phase of the Intersight Appliance's software upgrade. $ref: '#/components/schemas/onprem.UpgradePhase' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 readOnly: true x-omitempty: true Messages: type: array items: description: |- Messages generated during the software upgrade process. type: string readOnly: true x-omitempty: true RollbackNeeded: description: |- Track if rollback is needed. type: boolean x-omitempty: true RollbackPhases: type: array items: description: |- Collection of the completed software rollback phases. $ref: '#/components/schemas/onprem.UpgradePhase' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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 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 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 Version: description: |- Software upgrade manifest's version. type: string readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. ImageBundle: # A Relationship to MO appliance.ImageBundle $ref: '#/components/schemas/appliance.ImageBundle.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a applianceImageBundle resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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 is a sinlgeton managed object. A default upgrade policy is created during the Intersight Appliance setup, and it is configured with an automatic upgrade policy. Automatic upgrade policy lets the system start software upgrade after a pre-defined number of seconds set in the software manifest. Scheduled upgrade policy lets the user start software upgrade at a specified schedule. However, scheduled time cannot be beyond the time limit enforced by the upgrade grace period set in the software manifest. x-allOf-name: appliance.UpgradePolicy allOf: - # This 'appliance.UpgradePolicy' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'appliance.UpgradePolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'appliance.UpgradePolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'appliance.UpgradePolicy' ObjectType: enum: - 'appliance.UpgradePolicy' 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 Schedule: description: |- User defined schedule for upgrading the Intersight Appliance software. $ref: '#/components/schemas/onprem.Schedule' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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 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 allOf: - # This 'asset.AddressInformation' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.AddressInformation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.AddressInformation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.AddressInformation' ObjectType: enum: - 'asset.AddressInformation' 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 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 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 State: description: |- State in which the address resides. example "CA". type: string 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: - # This 'asset.CloudConnection' class inherits all properties from its parent class asset.Connection. $ref: '#/components/schemas/asset.Connection' - # The definition of all the properties specified in this 'asset.CloudConnection' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.CloudConnection', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.CloudConnection' ObjectType: enum: - 'asset.CloudConnection' Credential: description: |- The credential to be used to authenticate with the managed target. $ref: '#/components/schemas/asset.Credential' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true asset.ClusterMember.Response: description: |- The response body of a HTTP GET request for the 'asset.ClusterMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' asset.ClusterMember: title: Asset:Cluster Member description: |- A node within a cluster of device connectors. A Device Registration may contain multiple ClusterMembers with each holding the connection details of the device connector as well as the nodes current leadership within the cluster. x-allOf-name: asset.ClusterMember allOf: - # This 'asset.ClusterMember' class inherits all properties from its parent class asset.DeviceConnection. $ref: '#/components/schemas/asset.DeviceConnection' - # The definition of all the properties specified in this 'asset.ClusterMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.ClusterMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.ClusterMember' ObjectType: enum: - 'asset.ClusterMember' 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. * `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. * `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 in a given cluster, while the underlying platform may be active-active only one connector will assume the primary role. * `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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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 allOf: - # This 'asset.Connection' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' asset.ConnectionControlMessage: title: Asset:Connection Control Message description: |- Control message used to update the context of a devices connection. When a device registration is modified (e.g. by a user modifying the claim status) the process managing the connection must be notified of the change. On changes aurora will attempt to send the change to the current owner of the connection. x-allOf-name: asset.ConnectionControlMessage allOf: - # This 'asset.ConnectionControlMessage' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.ConnectionControlMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.ConnectionControlMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.ConnectionControlMessage' ObjectType: enum: - 'asset.ConnectionControlMessage' Account: description: |- The account id to which the device belongs. type: string x-omitempty: true ConnectorVersion: description: |- The version of the device connector currently running on the platform. Deprecated by newer connectors that will report this directly to the device connector gateway in a websocket header, but included to continue to support older versions which report any version change after connect. type: string x-omitempty: true DeviceId: description: |- The Moid of the device under change. Used to route the message to a devices connection. type: string x-omitempty: true DomainGroup: description: |- The domain group id to which the device belongs. type: string x-omitempty: true Evict: description: |- Flag to force any open connections to be evicted. Used in case device has been deleted or blacklisted. type: boolean x-omitempty: true Leadership: description: |- The current leadership of a device cluster member. * `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. * `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 in a given cluster, while the underlying platform may be active-active only one connector will assume the primary role. * `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 x-omitempty: true NewIdentity: description: |- The new identity assigned to a device on ownership change (claim/unclaim). type: string x-omitempty: true Partition: description: |- The partition the device was last connected to, used to address the control message to the device connector gateway instance holding the devices connection. type: integer format: int64 x-omitempty: true asset.ContractInformation: title: Asset:Contract Information description: |- Type for saving contract information. x-allOf-name: asset.ContractInformation allOf: - # This 'asset.ContractInformation' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.ContractInformation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.ContractInformation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.ContractInformation' ObjectType: enum: - 'asset.ContractInformation' BillTo: description: |- BillTo address of listed for the contract. $ref: '#/components/schemas/asset.AddressInformation' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true BillToGlobalUltimate: description: |- BillToGlobalUltimate information listed in the contract. $ref: '#/components/schemas/asset.GlobalUltimate' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 allOf: - # This 'asset.Credential' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' asset.CustomerInformation: title: Asset:Customer Information description: |- Type for saving contract information. x-allOf-name: asset.CustomerInformation allOf: - # This 'asset.CustomerInformation' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.CustomerInformation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.CustomerInformation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.CustomerInformation' ObjectType: enum: - 'asset.CustomerInformation' Address: description: |- Address as per the information provided by the user. $ref: '#/components/schemas/asset.AddressInformation' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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.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' 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: - # This 'asset.DeviceClaim' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'asset.DeviceClaim' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.DeviceClaim', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.DeviceClaim' ObjectType: enum: - 'asset.DeviceClaim' DeviceUpdates: type: array items: description: |- The list of devices that underwent change during the claim process. $ref: '#/components/schemas/asset.ConnectionControlMessage' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true asset.DeviceConfiguration.Response: description: |- The response body of a HTTP GET request for the 'asset.DeviceConfiguration' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'asset.DeviceConfiguration' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'asset.DeviceConfiguration' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.DeviceConfiguration', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.DeviceConfiguration' ObjectType: enum: - 'asset.DeviceConfiguration' 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 Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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' 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: - # This 'asset.DeviceConnection' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'asset.DeviceConnection' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.DeviceConnection', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ApiVersion: description: |- The version of the connector API, describes the capability of the connector's framework. If 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. * `` - The device registered with Intersight but subsequently did not establish a persistent websocket connection. * `Connected` - The device's connection to Intersight has been established and is active. * `NotConnected` - The device's connection to Intersight has been disconnected. * `ClaimInProgress` - Claim of the device is in progress. * `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. type: string enum: - '' - 'Connected' - 'NotConnected' - 'ClaimInProgress' - 'Unclaimed' 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. This could be the IP address of the managed device's interface which has a route to the internet or a NAT IP addresss 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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Information pertaining to a Registered Intersight Assist Appliance Device in Intersight. x-allOf-name: asset.DeviceConnectorManager allOf: - # This 'asset.DeviceConnectorManager' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'asset.DeviceConnectorManager' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.DeviceConnectorManager', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.DeviceConnectorManager' ObjectType: enum: - 'asset.DeviceConnectorManager' RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: title: Asset:Device Contract Information description: |- Contains information about the Cisco device identified by a unique identifier like serial number. It also contains information about warranty, contract status, validity of the device. In future this object could be expanded to store Case, RMA, device topology details. We observe new asset.DeviceRegisteration and use it as a trigger for creating an instance of this object. Currently the data is restricted to Cisco Standalone IMC servers and Fabric Interconnects. Support for more product lines will be added in future. x-allOf-name: asset.DeviceContractInformation allOf: - # This 'asset.DeviceContractInformation' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'asset.DeviceContractInformation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.DeviceContractInformation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.DeviceContractInformation' ObjectType: enum: - 'asset.DeviceContractInformation' Contract: description: |- Contract information for the Cisco support contract purchased for the Cisco device. $ref: '#/components/schemas/asset.ContractInformation' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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. * `Not Covered` - The Cisco device does not have a valid support contract. * `Active` - The Cisco device is covered under a active support contract. * `Expiring Soon` - The contract for this Cisco device is going to expire in the next 30 days. type: string enum: - 'Not Covered' - 'Active' - 'Expiring Soon' default: Not Covered 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. * `None` - A default value to catch cases where device type is not correctly detected. * `CiscoUcsServer` - A device of type server. It includes Cisco IMC and UCS Managed servers. * `CiscoUcsFI` - A device of type Fabric Interconnect. It includes the various types of Cisco Fabric Interconnects supported by Cisco Intersight. * `CiscoUcsChassis` - A device of type Chassis. It includes various UCS chassis supported by Cisco Intersight. type: string enum: - 'None' - 'CiscoUcsServer' - 'CiscoUcsFI' - 'CiscoUcsChassis' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true EndUserGlobalUltimate: description: |- EndUserGlobalUltimate information listed in the contract. $ref: '#/components/schemas/asset.GlobalUltimate' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 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. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' default: "" readOnly: true x-omitempty: true Product: description: |- Product information of the offering under a contract. $ref: '#/components/schemas/asset.ProductInformation' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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. * `Update` - Sn2Info/Contract information needs to be updated. * `OK` - Sn2Info/Contract information was fetched succcessfuly and updated. * `Failed` - Sn2Info/Contract information was not available or failed while fetching. * `Retry` - Sn2Info/Contract information update failed and will be retried later. type: string enum: - 'Update' - 'OK' - 'Failed' - 'Retry' 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: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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.DeviceRegistration.Response: description: |- The response body of a HTTP GET request for the 'asset.DeviceRegistration' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' asset.DeviceRegistration: title: Asset:Device Registration description: |- DeviceRegistration represents a device connector enabled endpoint which has registered with Intersight. x-allOf-name: asset.DeviceRegistration allOf: - # This 'asset.DeviceRegistration' class inherits all properties from its parent class asset.DeviceConnection. $ref: '#/components/schemas/asset.DeviceConnection' - # The definition of all the properties specified in this 'asset.DeviceRegistration' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.DeviceRegistration', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.DeviceRegistration' ObjectType: enum: - 'asset.DeviceRegistration' 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 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 ExecutionMode: description: |- Indicates if the platform is an actual device or an emulated device for testing, demos, etc. Permitted values are [Normal, Emulator, ContainerEmulator]. * `` - The device reported an empty or unrecognized executionMode. * `Normal` - The device connector is running in normal mode, i.e. it is not a simulation. * `Emulator` - The device connector is running in simulation mode inside an emulated device. * `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 used to authenticate that a leaf device is connected through the parent. $ref: '#/components/schemas/asset.ParentConnectionSignature' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 PlatformType: description: |- The platform type on which device connector is executing. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' 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 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 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 Vendor: description: |- The vendor of the managed device. type: string readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ClaimedByUser: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ClusterMembers: # A Relationship to MO asset.ClusterMember description: An array of relationships to assetClusterMember resources. type: array items: $ref: '#/components/schemas/asset.ClusterMember.Relationship' nullable: true readOnly: true DeviceClaim: # A Relationship to MO asset.DeviceClaim $ref: '#/components/schemas/asset.DeviceClaim.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceClaim resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true DeviceConfiguration: # A Relationship to MO asset.DeviceConfiguration $ref: '#/components/schemas/asset.DeviceConfiguration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceConfiguration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true DomainGroup: # A Relationship to MO iam.DomainGroup $ref: '#/components/schemas/iam.DomainGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamDomainGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ParentConnection: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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.GlobalUltimate: title: Asset:Global Ultimate description: |- Type for customer information of the BillToGlobal. x-allOf-name: asset.GlobalUltimate allOf: - # This 'asset.GlobalUltimate' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.GlobalUltimate' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.GlobalUltimate', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.GlobalUltimate' ObjectType: enum: - 'asset.GlobalUltimate' 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.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: - # This 'asset.HttpConnection' class inherits all properties from its parent class asset.Connection. $ref: '#/components/schemas/asset.Connection' - # The definition of all the properties specified in this 'asset.HttpConnection' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.HttpConnection', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.HttpConnection' ObjectType: enum: - 'asset.HttpConnection' Credential: description: |- The credential to be used to authenticate with the managed target. $ref: '#/components/schemas/asset.Credential' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IsSecure: description: |- Indicates whether a connection to the target should be established using HTTPS. type: boolean 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 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 maximum: 65535 x-omitempty: true asset.ManagedDevice.Response: description: |- The response body of a HTTP GET request for the 'asset.ManagedDevice' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'asset.ManagedDevice' resources. x-one-of-name: asset.ManagedDevice.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/asset.ManagedDevice.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType asset.ManagedDevice: title: Managed Device description: |- Attributes for Managed Device in Intersight and it maintains the relationship to the Intersight Assist Device. Once added, Device Connector for the Managed Device type is started on the Intersight Assist and status related to it is maintained. x-allOf-name: asset.ManagedDevice allOf: - # This 'asset.ManagedDevice' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'asset.ManagedDevice' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.ManagedDevice', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.ManagedDevice' ObjectType: enum: - 'asset.ManagedDevice' Credential: description: |- Credentials to manage Managed Device. $ref: '#/components/schemas/comm.Credential' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true DeviceType: description: |- Type of the Device such as VMware, Pure Storage supported by Intersight Assist. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' default: "" x-omitempty: true IgnoreCert: description: |- Ignore Certificates with protocol https for connecting to the Managed Device. It is not used for other protocols. type: boolean x-omitempty: true IsEnabled: description: |- Device is Enabled/Disabled. type: boolean x-omitempty: true ManagementAddress: description: |- Management address of the device. It can be IPv4, IPv6 or FQDN. type: string x-omitempty: true Port: description: |- Port to use for connecting to the Managed Device. Port is optional. If not specified, default port for protocol is used. type: integer format: int64 x-omitempty: true Protocol: description: |- Protocol to use for connecting to the Managed Device. * `https` - HTTPS communication is used for connecting to Device. * `http` - HTTP communication is used for connecting to Device. type: string enum: - 'https' - 'http' default: https x-omitempty: true Status: description: |- Status of communication releated to Managed Device. $ref: '#/components/schemas/asset.ManagedDeviceStatus' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. DeviceConnectorManager: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true WorkflowInfo: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true asset.ManagedDevice.List: title: List of 'asset.ManagedDevice' resources description: |- This resource list is returned as a response to a HTTP GET 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.ManagedDevice' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'asset.ManagedDevice' resources matching the request. type: array items: $ref: '#/components/schemas/asset.ManagedDevice' nullable: true asset.ManagedDeviceStatus: title: Asset:Managed Device Status description: |- Maintains the Managed Device Status. x-allOf-name: asset.ManagedDeviceStatus allOf: - # This 'asset.ManagedDeviceStatus' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.ManagedDeviceStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.ManagedDeviceStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.ManagedDeviceStatus' ObjectType: enum: - 'asset.ManagedDeviceStatus' CloudPort: description: |- Port used for the connection to the Cloud by the Device Connector for the Managed Device. type: integer format: int64 x-omitempty: true ConnectionFailureReason: description: |- Maintains the reason for the failure of connection to the Device in case of connection failure. type: string x-omitempty: true ConnectionStatus: description: |- Maintains the status of the connection to the Device. * `Unknown` - This represents Connection Status as unknown. * `Success` - This represents Connection Status as successful. * `Failure` - This represents Connection Status as failure. type: string enum: - 'Unknown' - 'Success' - 'Failure' default: Unknown x-omitempty: true ErrorCode: description: |- Maintains code related to error from Device Connector, if any. type: integer format: int64 x-omitempty: true ErrorReason: description: |- Maintains the reason for the error from Device Connector, if any. type: string x-omitempty: true ProcessId: description: |- Maintains the process pid of the Device Connector for the Managed Device. type: integer format: int64 x-omitempty: true ServerPort: description: |- Port used for receiving requests from Intersight Assist by the Device Connector for the Managed Device. type: integer format: int64 x-omitempty: true State: description: |- Maintains the state of the Managed Device, such as Start Success, Start Failure, etc. See ManagedDeviceState for device connection states. * `New` - State when the Managed Device is created. * `StartSent` - State when Create Managed Device is sent successfully to Intersight Assist to start Managed Device Device Connector. * `StartSentFailure` - State when Create Managed Device failed to send start Device Connector to Intersight Assist. * `StartSuccess` - State when Device Connector for the Managed Device has been successfully started. * `StartFailure` - State when Device Connector for the Managed Device failed to start. * `UpdateSentFailure` - State when Update Managed Device request is failed to be sent to Device Connector for the Managed Device. * `UpdateSent` - State when Update Managed Device request is successfully sent to Device Connector for the Managed Device. * `DeleteSentFailure` - State when Delete Managed Device request is failed to be sent to Intersight Assist. * `DeleteInProgress` - State when Intersight Assist received delete Managed Device request successfully. * `DeleteFailure` - State when Intersight Assist failed to stop Device Connector for the Managed Device. * `DeleteSuccess` - State when Intersight Assist stopped Device Connector for the Managed Device successfully. type: string enum: - 'New' - 'StartSent' - 'StartSentFailure' - 'StartSuccess' - 'StartFailure' - 'UpdateSentFailure' - 'UpdateSent' - 'DeleteSentFailure' - 'DeleteInProgress' - 'DeleteFailure' - 'DeleteSuccess' default: New 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: - # This 'asset.OrchestrationService' class inherits all properties from its parent class asset.Service. $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: - # This 'asset.ParentConnectionSignature' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.ParentConnectionSignature' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.ParentConnectionSignature', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.ParentConnectionSignature' ObjectType: enum: - 'asset.ParentConnectionSignature' 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 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.ProductInformation: title: Asset:Product Information description: |- Type for saving the product information. x-allOf-name: asset.ProductInformation allOf: - # This 'asset.ProductInformation' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.ProductInformation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.ProductInformation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.ProductInformation' ObjectType: enum: - 'asset.ProductInformation' BillTo: description: |- Billing address provided by customer while buying this Cisco product. $ref: '#/components/schemas/asset.AddressInformation' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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.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 allOf: - # This 'asset.Service' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.Service' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.Service', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Options: description: |- Captures configuration that is specific to a target type for a specific service. $ref: '#/components/schemas/asset.ServiceOptions' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Status: description: |- Status indicates if the respective Service can establish a connection and authenticate with the managed target. Status does not include information about the functional health of the target. * `` - The device registered with Intersight but subsequently did not establish a persistent websocket connection. * `Connected` - The device's connection to Intersight has been established and is active. * `NotConnected` - The device's connection to Intersight has been disconnected. * `ClaimInProgress` - Claim of the device is in progress. * `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. type: string enum: - '' - 'Connected' - 'NotConnected' - 'ClaimInProgress' - 'Unclaimed' default: "" x-omitempty: true StatusErrorReason: description: |- When 'Status' is not Connected, statusErrorReason provides further details about why the device is not connected with Intersight. type: string 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 allOf: - # This 'asset.ServiceOptions' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' 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 strucure contains the SUDI information read from the device's Trust Anchor Module (TAM). x-allOf-name: asset.SudiInfo allOf: - # This 'asset.SudiInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'asset.SudiInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.SudiInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.SudiInfo' ObjectType: enum: - 'asset.SudiInfo' Pid: description: |- The device model (PID) extracted from the X.509 SUDI Leaf Certificate. type: string x-omitempty: true SerialNumber: description: |- The device SerialNumber extracted from the X.509 SUDI Leaf Certiicate. type: string x-omitempty: true Signature: description: |- The signature is obtained by taking the base64 encoding of the Serial Number + PID + Status, taking the SHA256 hash and then signing with the SUDI X.509 Leaf Certifiate. type: string x-omitempty: true Status: description: |- The validation status of the device. * `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. * `Verified` - The device returned a valid PID, Serial Number, Status and X.509 Leaf Certificate. The certificate signing chain was validated. * `CertificateValidationFailed` - Validation of the certificate signing chain failed. * `UnsupportedFirmware` - The firmware version of the Cisco IMC that is installed does not contain the SUDI APIs needed to perform validation. * `UnsupportedHardware` - The device is a model that does not contain a Trust Anchor Module (TAM) and thus cannot be validated. * `DeviceNotResponding` - An request was sent to the device, but no response was received. type: string enum: - 'DeviceStatusUnknown' - 'Verified' - 'CertificateValidationFailed' - 'UnsupportedFirmware' - 'UnsupportedHardware' - 'DeviceNotResponding' default: DeviceStatusUnknown 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true asset.Target.Response: description: |- The response body of a HTTP GET request for the 'asset.Target' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: title: Asset:Target description: |- Target represents an entity which can be managed by Intersight. This includes physical entities like UCS and HyperFlex servers and software entities like VMware vCenter and Microsoft Azure cloud accounts. x-allOf-name: asset.Target allOf: - # This 'asset.Target' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'asset.Target' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.Target', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.Target' ObjectType: enum: - 'asset.Target' Connections: type: array items: description: |- A list of methods for connecting to the managed target. $ref: '#/components/schemas/asset.Connection' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 maxItems: 1 Services: type: array items: description: |- A list of services which are enabled for the managed target. $ref: '#/components/schemas/asset.Service' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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. * `` - The device registered with Intersight but subsequently did not establish a persistent websocket connection. * `Connected` - The device's connection to Intersight has been established and is active. * `NotConnected` - The device's connection to Intersight has been disconnected. * `ClaimInProgress` - Claim of the device is in progress. * `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. type: string enum: - '' - 'Connected' - 'NotConnected' - 'ClaimInProgress' - 'Unclaimed' default: "" readOnly: true x-omitempty: true StatusErrorReason: description: |- StatusErrorReason provides additional context for the Status. type: string readOnly: true x-omitempty: true TargetType: description: |- The type of the managed target. For example a UCS Server or Vmware Vcenter target. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' default: "" x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. Assist: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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. The '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.UsernamePasswordCredential: title: Asset:Username Password Credential description: |- An credential which performs authentication based on a username and password. x-allOf-name: asset.UsernamePasswordCredential allOf: - # This 'asset.UsernamePasswordCredential' class inherits all properties from its parent class asset.Credential. $ref: '#/components/schemas/asset.Credential' - # The definition of all the properties specified in this 'asset.UsernamePasswordCredential' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.UsernamePasswordCredential', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.UsernamePasswordCredential' ObjectType: enum: - 'asset.UsernamePasswordCredential' IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean 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.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: - # This 'asset.WorkloadOptimizerService' class inherits all properties from its parent class asset.Service. $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: - # This 'asset.WorkloadOptimizerVmwareVcenterOptions' class inherits all properties from its parent class asset.ServiceOptions. $ref: '#/components/schemas/asset.ServiceOptions' - # The definition of all the properties specified in this 'asset.WorkloadOptimizerVmwareVcenterOptions' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'asset.WorkloadOptimizerVmwareVcenterOptions', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'asset.WorkloadOptimizerVmwareVcenterOptions' ObjectType: enum: - 'asset.WorkloadOptimizerVmwareVcenterOptions' 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 bios.BootDevice.Response: description: |- The response body of a HTTP GET request for the 'bios.BootDevice' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'bios.BootDevice' resources. x-one-of-name: bios.BootDevice.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/bios.BootDevice.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType bios.BootDevice.Relationship: description: A relationship to the 'bios.BootDevice' resource, or the expanded 'bios.BootDevice' resource, or the 'null' value. x-one-of-name: bios.BootDevice.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/bios.BootDevice' bios.BootDevice: title: Bios:Boot Device description: |- Actual boot devices of the system as enumerated by BIOS. x-allOf-name: bios.BootDevice allOf: - # This 'bios.BootDevice' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'bios.BootDevice' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'bios.BootDevice', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'bios.BootDevice' ObjectType: enum: - 'bios.BootDevice' DeviceName: description: |- Name of the Configured Boot Device. type: string readOnly: true x-omitempty: true DeviceType: description: |- Type of the Configured Boot Device. type: string readOnly: true x-omitempty: true BiosSystemBootOrder: # A Relationship to MO bios.SystemBootOrder $ref: '#/components/schemas/bios.SystemBootOrder.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a biosSystemBootOrder resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true bios.BootDevice.List: title: List of 'bios.BootDevice' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'bios.BootDevice' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'bios.BootDevice' resources matching the request. type: array items: $ref: '#/components/schemas/bios.BootDevice' nullable: true bios.BootMode.Response: description: |- The response body of a HTTP GET request for the 'bios.BootMode' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'bios.BootMode' resources. x-one-of-name: bios.BootMode.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/bios.BootMode.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType bios.BootMode.Relationship: description: A relationship to the 'bios.BootMode' resource, or the expanded 'bios.BootMode' resource, or the 'null' value. x-one-of-name: bios.BootMode.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/bios.BootMode' bios.BootMode: title: Bios:Boot Mode description: |- The mode through which bios has booted. x-allOf-name: bios.BootMode allOf: - # This 'bios.BootMode' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'bios.BootMode' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'bios.BootMode', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'bios.BootMode' ObjectType: enum: - 'bios.BootMode' ActualBootMode: description: |- The actual BIOS boot mode as reported by the platform BIOS. type: string x-omitempty: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true bios.BootMode.List: title: List of 'bios.BootMode' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'bios.BootMode' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'bios.BootMode' resources matching the request. type: array items: $ref: '#/components/schemas/bios.BootMode' nullable: true bios.Policy.Response: description: |- The response body of a HTTP GET request for the 'bios.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'bios.Policy' resources. x-one-of-name: bios.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/bios.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType bios.Policy: title: BIOS description: |- Policy for setting BIOS tokens on the endpoint. x-allOf-name: bios.Policy allOf: - # This 'bios.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'bios.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'bios.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'bios.Policy' ObjectType: enum: - 'bios.Policy' AcsControlGpu1state: description: |- BIOS Token for setting ACS Control GPU-1 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlGpu2state: description: |- BIOS Token for setting ACS Control GPU-2 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlGpu3state: description: |- BIOS Token for setting ACS Control GPU-3 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlGpu4state: description: |- BIOS Token for setting ACS Control GPU-4 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlGpu5state: description: |- BIOS Token for setting ACS Control GPU-5 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlGpu6state: description: |- BIOS Token for setting ACS Control GPU-6 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlGpu7state: description: |- BIOS Token for setting ACS Control GPU-7 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlGpu8state: description: |- BIOS Token for setting ACS Control GPU-8 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlSlot11state: description: |- BIOS Token for setting ACS Control Slot 11 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlSlot12state: description: |- BIOS Token for setting ACS Control Slot 12 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlSlot13state: description: |- BIOS Token for setting ACS Control Slot 13 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AcsControlSlot14state: description: |- BIOS Token for setting ACS Control Slot 14 configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AdjacentCacheLinePrefetch: description: |- BIOS Token for setting Adjacent Cache Line Prefetcher configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AllUsbDevices: description: |- BIOS Token for setting All USB Devices configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Altitude: description: |- BIOS Token for setting Altitude configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1500-m` - Value - 1500-m for configuring Altitude token. * `300-m` - Value - 300-m for configuring Altitude token. * `3000-m` - Value - 3000-m for configuring Altitude token. * `900-m` - Value - 900-m for configuring Altitude token. * `auto` - Value - auto for configuring Altitude token. type: string enum: - 'platform-default' - '1500-m' - '300-m' - '3000-m' - '900-m' - 'auto' default: platform-default x-omitempty: true AspmSupport: description: |- BIOS Token for setting ASPM Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring AspmSupport token. * `Disabled` - Value - Disabled for configuring AspmSupport token. * `Force L0s` - Value - Force L0s for configuring AspmSupport token. * `L1 Only` - Value - L1 Only for configuring AspmSupport token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'Force L0s' - 'L1 Only' default: platform-default x-omitempty: true AssertNmiOnPerr: description: |- BIOS Token for setting Assert NMI on PERR configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AssertNmiOnSerr: description: |- BIOS Token for setting Assert NMI on SERR configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AutoCcState: description: |- BIOS Token for setting Autonomous Core C-state configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true AutonumousCstateEnable: description: |- BIOS Token for setting CPU Autonomous Cstate configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true BaudRate: description: |- BIOS Token for setting Baud rate configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `115200` - Value - 115200 for configuring BaudRate token. * `19200` - Value - 19200 for configuring BaudRate token. * `38400` - Value - 38400 for configuring BaudRate token. * `57600` - Value - 57600 for configuring BaudRate token. * `9600` - Value - 9600 for configuring BaudRate token. type: string enum: - 'platform-default' - '115200' - '19200' - '38400' - '57600' - '9600' default: platform-default x-omitempty: true BmeDmaMitigation: description: |- BIOS Token for setting BME DMA Mitigation configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true BootOptionNumRetry: description: |- BIOS Token for setting Number of Retries configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `13` - Value - 13 for configuring BootOptionNumRetry token. * `5` - Value - 5 for configuring BootOptionNumRetry token. * `Infinite` - Value - Infinite for configuring BootOptionNumRetry token. type: string enum: - 'platform-default' - '13' - '5' - 'Infinite' default: platform-default x-omitempty: true BootOptionReCoolDown: description: |- BIOS Token for setting Cool Down Time (sec) configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `15` - Value - 15 for configuring BootOptionReCoolDown token. * `45` - Value - 45 for configuring BootOptionReCoolDown token. * `90` - Value - 90 for configuring BootOptionReCoolDown token. type: string enum: - 'platform-default' - '15' - '45' - '90' default: platform-default x-omitempty: true BootOptionRetry: description: |- BIOS Token for setting Boot option retry configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true BootPerformanceMode: description: |- BIOS Token for setting Boot Performance Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Max Efficient` - Value - Max Efficient for configuring BootPerformanceMode token. * `Max Performance` - Value - Max Performance for configuring BootPerformanceMode token. * `Set by Intel NM` - Value - Set by Intel NM for configuring BootPerformanceMode token. type: string enum: - 'platform-default' - 'Max Efficient' - 'Max Performance' - 'Set by Intel NM' default: platform-default x-omitempty: true CbsCmnCpuCpb: description: |- BIOS Token for setting Core Performance Boost configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnCpuCpb token. * `disabled` - Value - disabled for configuring CbsCmnCpuCpb token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' default: platform-default x-omitempty: true CbsCmnCpuGenDowncoreCtrl: description: |- BIOS Token for setting Downcore control configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnCpuGenDowncoreCtrl token. * `FOUR (2 + 2)` - Value - FOUR (2 + 2) for configuring CbsCmnCpuGenDowncoreCtrl token. * `FOUR (4 + 0)` - Value - FOUR (4 + 0) for configuring CbsCmnCpuGenDowncoreCtrl token. * `SIX (3 + 3)` - Value - SIX (3 + 3) for configuring CbsCmnCpuGenDowncoreCtrl token. * `THREE (3 + 0)` - Value - THREE (3 + 0) for configuring CbsCmnCpuGenDowncoreCtrl token. * `TWO (1 + 1)` - Value - TWO (1 + 1) for configuring CbsCmnCpuGenDowncoreCtrl token. * `TWO (2 + 0)` - Value - TWO (2 + 0) for configuring CbsCmnCpuGenDowncoreCtrl token. type: string enum: - 'platform-default' - 'Auto' - 'FOUR (2 + 2)' - 'FOUR (4 + 0)' - 'SIX (3 + 3)' - 'THREE (3 + 0)' - 'TWO (1 + 1)' - 'TWO (2 + 0)' default: platform-default x-omitempty: true CbsCmnCpuGlobalCstateCtrl: description: |- BIOS Token for setting Global C-state Control configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnCpuGlobalCstateCtrl token. * `disabled` - Value - disabled for configuring CbsCmnCpuGlobalCstateCtrl token. * `enabled` - Value - enabled for configuring CbsCmnCpuGlobalCstateCtrl token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true CbsCmnCpuL1streamHwPrefetcher: description: |- BIOS Token for setting L1 Stream HW Prefetcher configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnCpuL1streamHwPrefetcher token. * `disabled` - Value - disabled for configuring CbsCmnCpuL1streamHwPrefetcher token. * `enabled` - Value - enabled for configuring CbsCmnCpuL1streamHwPrefetcher token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true CbsCmnCpuL2streamHwPrefetcher: description: |- BIOS Token for setting L2 Stream HW Prefetcher configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnCpuL2streamHwPrefetcher token. * `disabled` - Value - disabled for configuring CbsCmnCpuL2streamHwPrefetcher token. * `enabled` - Value - enabled for configuring CbsCmnCpuL2streamHwPrefetcher token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true CbsCmnDeterminismSlider: description: |- BIOS Token for setting Determinism Slider configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnDeterminismSlider token. * `Performance` - Value - Performance for configuring CbsCmnDeterminismSlider token. * `Power` - Value - Power for configuring CbsCmnDeterminismSlider token. type: string enum: - 'platform-default' - 'Auto' - 'Performance' - 'Power' default: platform-default x-omitempty: true CbsCmnGnbNbIommu: description: |- BIOS Token for setting IOMMU configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnGnbNbIommu token. * `disabled` - Value - disabled for configuring CbsCmnGnbNbIommu token. * `enabled` - Value - enabled for configuring CbsCmnGnbNbIommu token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true CbsCmnMemCtrlBankGroupSwapDdr4: description: |- BIOS Token for setting Bank Group Swap configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnMemCtrlBankGroupSwapDdr4 token. * `disabled` - Value - disabled for configuring CbsCmnMemCtrlBankGroupSwapDdr4 token. * `enabled` - Value - enabled for configuring CbsCmnMemCtrlBankGroupSwapDdr4 token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true CbsCmnMemMapBankInterleaveDdr4: description: |- BIOS Token for setting Chipselect Interleaving configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmnMemMapBankInterleaveDdr4 token. * `disabled` - Value - disabled for configuring CbsCmnMemMapBankInterleaveDdr4 token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' default: platform-default x-omitempty: true CbsCmncTdpCtl: description: |- BIOS Token for setting cTDP Control configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsCmncTdpCtl token. * `Manual` - Value - Manual for configuring CbsCmncTdpCtl token. type: string enum: - 'platform-default' - 'Auto' - 'Manual' default: platform-default x-omitempty: true CbsDfCmnMemIntlv: description: |- BIOS Token for setting Memory interleaving configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CbsDfCmnMemIntlv token. * `Channel` - Value - Channel for configuring CbsDfCmnMemIntlv token. * `Channel NPS2` - Value - Channel NPS2 for configuring CbsDfCmnMemIntlv token. * `Channel NPS4` - Value - Channel NPS4 for configuring CbsDfCmnMemIntlv token. * `Die` - Value - Die for configuring CbsDfCmnMemIntlv token. * `Die NPS1` - Value - Die NPS1 for configuring CbsDfCmnMemIntlv token. * `None` - Value - None for configuring CbsDfCmnMemIntlv token. * `Socket` - Value - Socket for configuring CbsDfCmnMemIntlv token. * `Socket NPS0` - Value - Socket NPS0 for configuring CbsDfCmnMemIntlv token. type: string enum: - 'platform-default' - 'Auto' - 'Channel' - 'Channel NPS2' - 'Channel NPS4' - 'Die' - 'Die NPS1' - 'None' - 'Socket' - 'Socket NPS0' default: platform-default x-omitempty: true CbsDfCmnMemIntlvSize: description: |- BIOS Token for setting Memory interleaving size configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1 KB` - Value - 1 KiB for configuring CbsDfCmnMemIntlvSize token. * `2 KB` - Value - 2 KiB for configuring CbsDfCmnMemIntlvSize token. * `256 Bytes` - Value - 256 Bytes for configuring CbsDfCmnMemIntlvSize token. * `512 Bytes` - Value - 512 Bytes for configuring CbsDfCmnMemIntlvSize token. * `Auto` - Value - Auto for configuring CbsDfCmnMemIntlvSize token. type: string enum: - 'platform-default' - '1 KB' - '2 KB' - '256 Bytes' - '512 Bytes' - 'Auto' default: platform-default x-omitempty: true CdnEnable: description: |- BIOS Token for setting Consistent Device Naming configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true CdnSupport: description: |- BIOS Token for setting CDN Support for LOM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring CdnSupport token. * `enabled` - Value - enabled for configuring CdnSupport token. * `LOMs Only` - Value - LOMs Only for configuring CdnSupport token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'LOMs Only' default: platform-default x-omitempty: true ChannelInterLeave: description: |- BIOS Token for setting Channel Interleaving configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1-way` - Value - 1-way for configuring ChannelInterLeave token. * `2-way` - Value - 2-way for configuring ChannelInterLeave token. * `3-way` - Value - 3-way for configuring ChannelInterLeave token. * `4-way` - Value - 4-way for configuring ChannelInterLeave token. * `auto` - Value - auto for configuring ChannelInterLeave token. type: string enum: - 'platform-default' - '1-way' - '2-way' - '3-way' - '4-way' - 'auto' default: platform-default x-omitempty: true CiscoAdaptiveMemTraining: description: |- BIOS Token for setting Adaptive Memory Training configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true CiscoDebugLevel: description: |- BIOS Token for setting BIOS Techlog Level configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Maximum` - Value - Maximum for configuring CiscoDebugLevel token. * `Minimum` - Value - Minimum for configuring CiscoDebugLevel token. * `Normal` - Value - Normal for configuring CiscoDebugLevel token. type: string enum: - 'platform-default' - 'Maximum' - 'Minimum' - 'Normal' default: platform-default x-omitempty: true CiscoOpromLaunchOptimization: description: |- BIOS Token for setting OptionROM Launch Optimization configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true CkeLowPolicy: description: |- BIOS Token for setting CKE Low Policy configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `auto` - Value - auto for configuring CkeLowPolicy token. * `disabled` - Value - disabled for configuring CkeLowPolicy token. * `fast` - Value - fast for configuring CkeLowPolicy token. * `slow` - Value - slow for configuring CkeLowPolicy token. type: string enum: - 'platform-default' - 'auto' - 'disabled' - 'fast' - 'slow' default: platform-default x-omitempty: true ClosedLoopThermThrotl: description: |- BIOS Token for setting Closed Loop Therm Throt configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true CmciEnable: description: |- BIOS Token for setting Processor CMCI configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true ConfigTdp: description: |- BIOS Token for setting Config TDP configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true ConfigTdpLevel: description: |- BIOS Token for setting Configurable TDP Level configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Level 1` - Value - Level 1 for configuring ConfigTdpLevel token. * `Level 2` - Value - Level 2 for configuring ConfigTdpLevel token. * `Normal` - Value - Normal for configuring ConfigTdpLevel token. type: string enum: - 'platform-default' - 'Level 1' - 'Level 2' - 'Normal' default: platform-default x-omitempty: true ConsoleRedirection: description: |- BIOS Token for setting Console redirection configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `com-0` - Value - com-0 for configuring ConsoleRedirection token. * `com-1` - Value - com-1 for configuring ConsoleRedirection token. * `disabled` - Value - disabled for configuring ConsoleRedirection token. * `enabled` - Value - enabled for configuring ConsoleRedirection token. * `serial-port-a` - Value - serial-port-a for configuring ConsoleRedirection token. type: string enum: - 'platform-default' - 'com-0' - 'com-1' - 'disabled' - 'enabled' - 'serial-port-a' default: platform-default x-omitempty: true CoreMultiProcessing: description: |- BIOS Token for setting Core MultiProcessing configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1` - Value - 1 for configuring CoreMultiProcessing token. * `10` - Value - 10 for configuring CoreMultiProcessing token. * `11` - Value - 11 for configuring CoreMultiProcessing token. * `12` - Value - 12 for configuring CoreMultiProcessing token. * `13` - Value - 13 for configuring CoreMultiProcessing token. * `14` - Value - 14 for configuring CoreMultiProcessing token. * `15` - Value - 15 for configuring CoreMultiProcessing token. * `16` - Value - 16 for configuring CoreMultiProcessing token. * `17` - Value - 17 for configuring CoreMultiProcessing token. * `18` - Value - 18 for configuring CoreMultiProcessing token. * `19` - Value - 19 for configuring CoreMultiProcessing token. * `2` - Value - 2 for configuring CoreMultiProcessing token. * `20` - Value - 20 for configuring CoreMultiProcessing token. * `21` - Value - 21 for configuring CoreMultiProcessing token. * `22` - Value - 22 for configuring CoreMultiProcessing token. * `23` - Value - 23 for configuring CoreMultiProcessing token. * `24` - Value - 24 for configuring CoreMultiProcessing token. * `25` - Value - 25 for configuring CoreMultiProcessing token. * `26` - Value - 26 for configuring CoreMultiProcessing token. * `27` - Value - 27 for configuring CoreMultiProcessing token. * `28` - Value - 28 for configuring CoreMultiProcessing token. * `3` - Value - 3 for configuring CoreMultiProcessing token. * `4` - Value - 4 for configuring CoreMultiProcessing token. * `5` - Value - 5 for configuring CoreMultiProcessing token. * `6` - Value - 6 for configuring CoreMultiProcessing token. * `7` - Value - 7 for configuring CoreMultiProcessing token. * `8` - Value - 8 for configuring CoreMultiProcessing token. * `9` - Value - 9 for configuring CoreMultiProcessing token. * `all` - Value - all for configuring CoreMultiProcessing token. type: string enum: - 'platform-default' - '1' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '2' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - 'all' default: platform-default x-omitempty: true CpuEnergyPerformance: description: |- BIOS Token for setting Energy Performance configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `balanced-energy` - Value - balanced-energy for configuring CpuEnergyPerformance token. * `balanced-performance` - Value - balanced-performance for configuring CpuEnergyPerformance token. * `balanced-power` - Value - balanced-power for configuring CpuEnergyPerformance token. * `energy-efficient` - Value - energy-efficient for configuring CpuEnergyPerformance token. * `performance` - Value - performance for configuring CpuEnergyPerformance token. * `power` - Value - power for configuring CpuEnergyPerformance token. type: string enum: - 'platform-default' - 'balanced-energy' - 'balanced-performance' - 'balanced-power' - 'energy-efficient' - 'performance' - 'power' default: platform-default x-omitempty: true CpuFrequencyFloor: description: |- BIOS Token for setting Frequency Floor Override configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true CpuPerformance: description: |- BIOS Token for setting CPU Performance configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `custom` - Value - custom for configuring CpuPerformance token. * `enterprise` - Value - enterprise for configuring CpuPerformance token. * `high-throughput` - Value - high-throughput for configuring CpuPerformance token. * `hpc` - Value - hpc for configuring CpuPerformance token. type: string enum: - 'platform-default' - 'custom' - 'enterprise' - 'high-throughput' - 'hpc' default: platform-default x-omitempty: true CpuPowerManagement: description: |- BIOS Token for setting Power Technology configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `custom` - Value - custom for configuring CpuPowerManagement token. * `disabled` - Value - disabled for configuring CpuPowerManagement token. * `energy-efficient` - Value - energy-efficient for configuring CpuPowerManagement token. * `performance` - Value - performance for configuring CpuPowerManagement token. type: string enum: - 'platform-default' - 'custom' - 'disabled' - 'energy-efficient' - 'performance' default: platform-default x-omitempty: true CrQos: description: |- BIOS Token for setting CR QoS configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Disabled` - Value - Disabled for configuring CrQos token. * `Recipe 1` - Value - Recipe 1 for configuring CrQos token. * `Recipe 2` - Value - Recipe 2 for configuring CrQos token. * `Recipe 3` - Value - Recipe 3 for configuring CrQos token. type: string enum: - 'platform-default' - 'Disabled' - 'Recipe 1' - 'Recipe 2' - 'Recipe 3' default: platform-default x-omitempty: true CrfastgoConfig: description: |- BIOS Token for setting CR FastGo Config configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring CrfastgoConfig token. * `Default` - Value - Default for configuring CrfastgoConfig token. * `Option 1` - Value - Option 1 for configuring CrfastgoConfig token. * `Option 2` - Value - Option 2 for configuring CrfastgoConfig token. * `Option 3` - Value - Option 3 for configuring CrfastgoConfig token. * `Option 4` - Value - Option 4 for configuring CrfastgoConfig token. * `Option 5` - Value - Option 5 for configuring CrfastgoConfig token. type: string enum: - 'platform-default' - 'Auto' - 'Default' - 'Option 1' - 'Option 2' - 'Option 3' - 'Option 4' - 'Option 5' default: platform-default x-omitempty: true DcpmmFirmwareDowngrade: description: |- BIOS Token for setting DCPMM Firmware Downgrade configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true DemandScrub: description: |- BIOS Token for setting Demand Scrub configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true DirectCacheAccess: description: |- BIOS Token for setting Direct Cache Access Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `auto` - Value - auto for configuring DirectCacheAccess token. * `disabled` - Value - disabled for configuring DirectCacheAccess token. * `enabled` - Value - enabled for configuring DirectCacheAccess token. type: string enum: - 'platform-default' - 'auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true DramClockThrottling: description: |- BIOS Token for setting DRAM Clock Throttling configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring DramClockThrottling token. * `Balanced` - Value - Balanced for configuring DramClockThrottling token. * `Energy Efficient` - Value - Energy Efficient for configuring DramClockThrottling token. * `Performance` - Value - Performance for configuring DramClockThrottling token. type: string enum: - 'platform-default' - 'Auto' - 'Balanced' - 'Energy Efficient' - 'Performance' default: platform-default x-omitempty: true DramRefreshRate: description: |- BIOS Token for setting DRAM Refresh Rate configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1x` - Value - 1x for configuring DramRefreshRate token. * `2x` - Value - 2x for configuring DramRefreshRate token. * `3x` - Value - 3x for configuring DramRefreshRate token. * `4x` - Value - 4x for configuring DramRefreshRate token. * `Auto` - Value - Auto for configuring DramRefreshRate token. type: string enum: - 'platform-default' - '1x' - '2x' - '3x' - '4x' - 'Auto' default: platform-default x-omitempty: true EnableClockSpreadSpec: description: |- BIOS Token for setting External SSC Enable configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true EnergyEfficientTurbo: description: |- BIOS Token for setting Energy Efficient Turbo configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true EngPerfTuning: description: |- BIOS Token for setting Energy Performance Tuning configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `BIOS` - Value - BIOS for configuring EngPerfTuning token. * `OS` - Value - OS for configuring EngPerfTuning token. type: string enum: - 'platform-default' - 'BIOS' - 'OS' default: platform-default x-omitempty: true EnhancedIntelSpeedStepTech: description: |- BIOS Token for setting Enhanced Intel Speedstep (R) Technology configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true EppProfile: description: |- BIOS Token for setting EPP Profile configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Balanced Performance` - Value - Balanced Performance for configuring EppProfile token. * `Balanced Power` - Value - Balanced Power for configuring EppProfile token. * `Performance` - Value - Performance for configuring EppProfile token. * `Power` - Value - Power for configuring EppProfile token. type: string enum: - 'platform-default' - 'Balanced Performance' - 'Balanced Power' - 'Performance' - 'Power' default: platform-default x-omitempty: true ExecuteDisableBit: description: |- BIOS Token for setting Execute Disable Bit configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true ExtendedApic: description: |- BIOS Token for setting Local X2 Apic configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring ExtendedApic token. * `enabled` - Value - enabled for configuring ExtendedApic token. * `X2APIC` - Value - X2APIC for configuring ExtendedApic token. * `XAPIC` - Value - XAPIC for configuring ExtendedApic token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'X2APIC' - 'XAPIC' default: platform-default x-omitempty: true FlowControl: description: |- BIOS Token for setting Flow Control configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `none` - Value - none for configuring FlowControl token. * `rts-cts` - Value - rts-cts for configuring FlowControl token. type: string enum: - 'platform-default' - 'none' - 'rts-cts' default: platform-default x-omitempty: true Frb2enable: description: |- BIOS Token for setting FRB-2 Timer configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true HardwarePrefetch: description: |- BIOS Token for setting Hardware Prefetcher configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true HwpmEnable: description: |- BIOS Token for setting CPU Hardware Power Management configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Disabled` - Value - Disabled for configuring HwpmEnable token. * `HWPM Native Mode` - Value - HWPM Native Mode for configuring HwpmEnable token. * `HWPM OOB Mode` - Value - HWPM OOB Mode for configuring HwpmEnable token. * `NATIVE MODE` - Value - NATIVE MODE for configuring HwpmEnable token. * `Native Mode with no Legacy` - Value - Native Mode with no Legacy for configuring HwpmEnable token. * `OOB MODE` - Value - OOB MODE for configuring HwpmEnable token. type: string enum: - 'platform-default' - 'Disabled' - 'HWPM Native Mode' - 'HWPM OOB Mode' - 'NATIVE MODE' - 'Native Mode with no Legacy' - 'OOB MODE' default: platform-default x-omitempty: true ImcInterleave: description: |- BIOS Token for setting IMC Interleaving configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1-way Interleave` - Value - 1-way Interleave for configuring ImcInterleave token. * `2-way Interleave` - Value - 2-way Interleave for configuring ImcInterleave token. * `Auto` - Value - Auto for configuring ImcInterleave token. type: string enum: - 'platform-default' - '1-way Interleave' - '2-way Interleave' - 'Auto' default: platform-default x-omitempty: true IntelHyperThreadingTech: description: |- BIOS Token for setting Intel HyperThreading Tech configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IntelSpeedSelect: description: |- BIOS Token for setting Intel Speed Select configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Base` - Value - Base for configuring IntelSpeedSelect token. * `Config 1` - Value - Config 1 for configuring IntelSpeedSelect token. * `Config 2` - Value - Config 2 for configuring IntelSpeedSelect token. type: string enum: - 'platform-default' - 'Base' - 'Config 1' - 'Config 2' default: platform-default x-omitempty: true IntelTurboBoostTech: description: |- BIOS Token for setting Intel Turbo Boost Tech configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IntelVirtualizationTechnology: description: |- BIOS Token for setting Intel (R) VT configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IntelVtForDirectedIo: description: |- BIOS Token for setting Intel VT for directed IO configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IntelVtdCoherencySupport: description: |- BIOS Token for setting Intel (R) VT-d Coherency Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IntelVtdInterruptRemapping: description: |- BIOS Token for setting Intel (R) VT-d Interrupt Remapping configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IntelVtdPassThroughDmaSupport: description: |- BIOS Token for setting Intel (R) VT-d PassThrough DMA support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IntelVtdatsSupport: description: |- BIOS Token for setting Intel VTD ATS support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true IohErrorEnable: description: |- BIOS Token for setting IIO Error Enable configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `No` - Value - No for configuring IohErrorEnable token. * `Yes` - Value - Yes for configuring IohErrorEnable token. type: string enum: - 'platform-default' - 'No' - 'Yes' default: platform-default x-omitempty: true IohResource: description: |- BIOS Token for setting IOH Resource Allocation configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `IOH0 24k IOH1 40k` - Value - IOH0 24k IOH1 40k for configuring IohResource token. * `IOH0 32k IOH1 32k` - Value - IOH0 32k IOH1 32k for configuring IohResource token. * `IOH0 40k IOH1 24k` - Value - IOH0 40k IOH1 24k for configuring IohResource token. * `IOH0 48k IOH1 16k` - Value - IOH0 48k IOH1 16k for configuring IohResource token. * `IOH0 56k IOH1 8k` - Value - IOH0 56k IOH1 8k for configuring IohResource token. type: string enum: - 'platform-default' - 'IOH0 24k IOH1 40k' - 'IOH0 32k IOH1 32k' - 'IOH0 40k IOH1 24k' - 'IOH0 48k IOH1 16k' - 'IOH0 56k IOH1 8k' default: platform-default x-omitempty: true IpPrefetch: description: |- BIOS Token for setting DCU IP Prefetcher configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Ipv4pxe: description: |- BIOS Token for setting IPv4 PXE Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Ipv6pxe: description: |- BIOS Token for setting IPV6 PXE Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true KtiPrefetch: description: |- BIOS Token for setting KTI Prefetch configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true LegacyOsRedirection: description: |- BIOS Token for setting Legacy OS redirection configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true LegacyUsbSupport: description: |- BIOS Token for setting Legacy USB Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `auto` - Value - auto for configuring LegacyUsbSupport token. * `disabled` - Value - disabled for configuring LegacyUsbSupport token. * `enabled` - Value - enabled for configuring LegacyUsbSupport token. type: string enum: - 'platform-default' - 'auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true LlcPrefetch: description: |- BIOS Token for setting LLC Prefetch configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true LomPort0state: description: |- BIOS Token for setting LOM Port 0 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring LomPort0state token. * `enabled` - Value - enabled for configuring LomPort0state token. * `Legacy Only` - Value - Legacy Only for configuring LomPort0state token. * `UEFI Only` - Value - UEFI Only for configuring LomPort0state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true LomPort1state: description: |- BIOS Token for setting LOM Port 1 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring LomPort1state token. * `enabled` - Value - enabled for configuring LomPort1state token. * `Legacy Only` - Value - Legacy Only for configuring LomPort1state token. * `UEFI Only` - Value - UEFI Only for configuring LomPort1state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true LomPort2state: description: |- BIOS Token for setting LOM Port 2 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring LomPort2state token. * `enabled` - Value - enabled for configuring LomPort2state token. * `Legacy Only` - Value - Legacy Only for configuring LomPort2state token. * `UEFI Only` - Value - UEFI Only for configuring LomPort2state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true LomPort3state: description: |- BIOS Token for setting LOM Port 3 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring LomPort3state token. * `enabled` - Value - enabled for configuring LomPort3state token. * `Legacy Only` - Value - Legacy Only for configuring LomPort3state token. * `UEFI Only` - Value - UEFI Only for configuring LomPort3state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true LomPortsAllState: description: |- BIOS Token for setting All Onboard LOM Ports configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true LvDdrMode: description: |- BIOS Token for setting Low Voltage DDR Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `auto` - Value - auto for configuring LvDdrMode token. * `performance-mode` - Value - performance-mode for configuring LvDdrMode token. * `power-saving-mode` - Value - power-saving-mode for configuring LvDdrMode token. type: string enum: - 'platform-default' - 'auto' - 'performance-mode' - 'power-saving-mode' default: platform-default x-omitempty: true MakeDeviceNonBootable: description: |- BIOS Token for setting Make Device Non Bootable configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true MemoryInterLeave: description: |- BIOS Token for setting Memory Interleaving configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1 Way Node Interleave` - Value - 1 Way Node Interleave for configuring MemoryInterLeave token. * `2 Way Node Interleave` - Value - 2 Way Node Interleave for configuring MemoryInterLeave token. * `4 Way Node Interleave` - Value - 4 Way Node Interleave for configuring MemoryInterLeave token. * `8 Way Node Interleave` - Value - 8 Way Node Interleave for configuring MemoryInterLeave token. * `disabled` - Value - disabled for configuring MemoryInterLeave token. * `enabled` - Value - enabled for configuring MemoryInterLeave token. type: string enum: - 'platform-default' - '1 Way Node Interleave' - '2 Way Node Interleave' - '4 Way Node Interleave' - '8 Way Node Interleave' - 'disabled' - 'enabled' default: platform-default x-omitempty: true MemoryMappedIoAbove4gb: description: |- BIOS Token for setting Memory mapped IO above 4GiB configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true MemorySizeLimit: description: |- BIOS Token for setting Memory Size Limit in GiB configuration (0-65535). type: string pattern: "^0*([0-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^platform-default$" x-omitempty: true MirroringMode: description: |- BIOS Token for setting Mirroring Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `inter-socket` - Value - inter-socket for configuring MirroringMode token. * `intra-socket` - Value - intra-socket for configuring MirroringMode token. type: string enum: - 'platform-default' - 'inter-socket' - 'intra-socket' default: platform-default x-omitempty: true MmcfgBase: description: |- BIOS Token for setting MMCFG BASE configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1 GB` - Value - 1 GiB for configuring MmcfgBase token. * `2 GB` - Value - 2 GiB for configuring MmcfgBase token. * `2.5 GB` - Value - 2.5 GiB for configuring MmcfgBase token. * `3 GB` - Value - 3 GiB for configuring MmcfgBase token. * `Auto` - Value - Auto for configuring MmcfgBase token. type: string enum: - 'platform-default' - '1 GB' - '2 GB' - '2.5 GB' - '3 GB' - 'Auto' default: platform-default x-omitempty: true NetworkStack: description: |- BIOS Token for setting Network Stack configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true NumaOptimized: description: |- BIOS Token for setting NUMA optimized configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true NvmdimmPerformConfig: description: |- BIOS Token for setting NVM Performance Setting configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `BW Optimized` - Value - BW Optimized for configuring NvmdimmPerformConfig token. * `Balanced Profile` - Value - Balanced Profile for configuring NvmdimmPerformConfig token. * `Latency Optimized` - Value - Latency Optimized for configuring NvmdimmPerformConfig token. type: string enum: - 'platform-default' - 'BW Optimized' - 'Balanced Profile' - 'Latency Optimized' default: platform-default x-omitempty: true Onboard10gbitLom: description: |- BIOS Token for setting Onboard 10Gbit LOM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true OnboardGbitLom: description: |- BIOS Token for setting Onboard Gbit LOM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true OnboardScuStorageSupport: description: |- BIOS Token for setting Onboard SCU Storage Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true OnboardScuStorageSwStack: description: |- BIOS Token for setting Onboard SCU Storage SW Stack configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Intel RSTe` - Value - Intel RSTe for configuring OnboardScuStorageSwStack token. * `LSI SW RAID` - Value - LSI SW RAID for configuring OnboardScuStorageSwStack token. type: string enum: - 'platform-default' - 'Intel RSTe' - 'LSI SW RAID' default: platform-default x-omitempty: true OsBootWatchdogTimer: description: |- BIOS Token for setting OS Boot Watchdog Timer configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true OsBootWatchdogTimerPolicy: description: |- BIOS Token for setting OS Boot Watchdog Timer Policy configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `do-nothing` - Value - do-nothing for configuring OsBootWatchdogTimerPolicy token. * `power-off` - Value - power-off for configuring OsBootWatchdogTimerPolicy token. * `reset` - Value - reset for configuring OsBootWatchdogTimerPolicy token. type: string enum: - 'platform-default' - 'do-nothing' - 'power-off' - 'reset' default: platform-default x-omitempty: true OsBootWatchdogTimerTimeout: description: |- BIOS Token for setting OS Boot Watchdog Timer Timeout configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `10-minutes` - Value - 10-minutes for configuring OsBootWatchdogTimerTimeout token. * `15-minutes` - Value - 15-minutes for configuring OsBootWatchdogTimerTimeout token. * `20-minutes` - Value - 20-minutes for configuring OsBootWatchdogTimerTimeout token. * `5-minutes` - Value - 5-minutes for configuring OsBootWatchdogTimerTimeout token. type: string enum: - 'platform-default' - '10-minutes' - '15-minutes' - '20-minutes' - '5-minutes' default: platform-default x-omitempty: true OutOfBandMgmtPort: description: |- BIOS Token for setting Out-of-Band Mgmt Port configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PackageCstateLimit: description: |- BIOS Token for setting Package C State Limit configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PackageCstateLimit token. * `C0 C1 State` - Value - C0 C1 State for configuring PackageCstateLimit token. * `C0/C1` - Value - C0/C1 for configuring PackageCstateLimit token. * `C2` - Value - C2 for configuring PackageCstateLimit token. * `C6 Non Retention` - Value - C6 Non Retention for configuring PackageCstateLimit token. * `C6 Retention` - Value - C6 Retention for configuring PackageCstateLimit token. * `No Limit` - Value - No Limit for configuring PackageCstateLimit token. type: string enum: - 'platform-default' - 'Auto' - 'C0 C1 State' - 'C0/C1' - 'C2' - 'C6 Non Retention' - 'C6 Retention' - 'No Limit' default: platform-default x-omitempty: true PartialMirrorModeConfig: description: |- BIOS Token for setting Partial Memory Mirror Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring PartialMirrorModeConfig token. * `Percentage` - Value - Percentage for configuring PartialMirrorModeConfig token. * `Value in GB` - Value - Value in GiB for configuring PartialMirrorModeConfig token. type: string enum: - 'platform-default' - 'disabled' - 'Percentage' - 'Value in GB' default: platform-default x-omitempty: true PartialMirrorPercent: description: |- BIOS Token for setting Partial Mirror percentage configuration (0.00-50.00). type: string pattern: "^0*(([0-9]|[1-4][0-9])\\.)\\d{1,2}$|^0*50.00$|^0*50.0$|^platform-default$" x-omitempty: true PartialMirrorValue1: description: |- BIOS Token for setting Partial Mirror1 Size in GiB configuration (0-65535). type: string pattern: "^0*([0-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^platform-default$" x-omitempty: true PartialMirrorValue2: description: |- BIOS Token for setting Partial Mirror2 Size in GiB configuration (0-65535). type: string pattern: "^0*([0-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^platform-default$" x-omitempty: true PartialMirrorValue3: description: |- BIOS Token for setting Partial Mirror3 Size in GiB configuration (0-65535). type: string pattern: "^0*([0-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^platform-default$" x-omitempty: true PartialMirrorValue4: description: |- BIOS Token for setting Partial Mirror4 Size in GiB configuration (0-65535). type: string pattern: "^0*([0-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^platform-default$" x-omitempty: true PatrolScrub: description: |- BIOS Token for setting Patrol Scrub configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PatrolScrubDuration: description: |- BIOS Token for setting Patrol Scrub Interval configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcIeRasSupport: description: |- BIOS Token for setting PCIe RAS Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcIeSsdHotPlugSupport: description: |- BIOS Token for setting NVMe SSD Hot-Plug Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PchUsb30mode: description: |- BIOS Token for setting xHCI Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PciOptionRoMs: description: |- BIOS Token for setting All PCIe Slots OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring PciOptionRoMs token. * `enabled` - Value - enabled for configuring PciOptionRoMs token. * `Legacy Only` - Value - Legacy Only for configuring PciOptionRoMs token. * `UEFI Only` - Value - UEFI Only for configuring PciOptionRoMs token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true PciRomClp: description: |- BIOS Token for setting PCI ROM CLP configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcieAriSupport: description: |- BIOS Token for setting PCIe ARI Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PcieAriSupport token. * `disabled` - Value - disabled for configuring PcieAriSupport token. * `enabled` - Value - enabled for configuring PcieAriSupport token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true PciePllSsc: description: |- BIOS Token for setting PCIe PLL SSC configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PciePllSsc token. * `Disabled` - Value - Disabled for configuring PciePllSsc token. * `ZeroPointFive` - Value - ZeroPointFive for configuring PciePllSsc token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'ZeroPointFive' default: platform-default x-omitempty: true PcieSlotMstorraidOptionRom: description: |- BIOS Token for setting PCIe Slot MSTOR RAID OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcieSlotNvme1linkSpeed: description: |- BIOS Token for setting NVME-1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PcieSlotNvme1linkSpeed token. * `Disabled` - Value - Disabled for configuring PcieSlotNvme1linkSpeed token. * `GEN1` - Value - GEN1 for configuring PcieSlotNvme1linkSpeed token. * `GEN2` - Value - GEN2 for configuring PcieSlotNvme1linkSpeed token. * `GEN3` - Value - GEN3 for configuring PcieSlotNvme1linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true PcieSlotNvme1optionRom: description: |- BIOS Token for setting NVME-1 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcieSlotNvme2linkSpeed: description: |- BIOS Token for setting NVME-2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PcieSlotNvme2linkSpeed token. * `Disabled` - Value - Disabled for configuring PcieSlotNvme2linkSpeed token. * `GEN1` - Value - GEN1 for configuring PcieSlotNvme2linkSpeed token. * `GEN2` - Value - GEN2 for configuring PcieSlotNvme2linkSpeed token. * `GEN3` - Value - GEN3 for configuring PcieSlotNvme2linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true PcieSlotNvme2optionRom: description: |- BIOS Token for setting NVME-2 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcieSlotNvme3linkSpeed: description: |- BIOS Token for setting NVME-3 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PcieSlotNvme3linkSpeed token. * `Disabled` - Value - Disabled for configuring PcieSlotNvme3linkSpeed token. * `GEN1` - Value - GEN1 for configuring PcieSlotNvme3linkSpeed token. * `GEN2` - Value - GEN2 for configuring PcieSlotNvme3linkSpeed token. * `GEN3` - Value - GEN3 for configuring PcieSlotNvme3linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true PcieSlotNvme3optionRom: description: |- BIOS Token for setting NVME-3 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcieSlotNvme4linkSpeed: description: |- BIOS Token for setting NVME-4 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PcieSlotNvme4linkSpeed token. * `Disabled` - Value - Disabled for configuring PcieSlotNvme4linkSpeed token. * `GEN1` - Value - GEN1 for configuring PcieSlotNvme4linkSpeed token. * `GEN2` - Value - GEN2 for configuring PcieSlotNvme4linkSpeed token. * `GEN3` - Value - GEN3 for configuring PcieSlotNvme4linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true PcieSlotNvme4optionRom: description: |- BIOS Token for setting NVME-4 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcieSlotNvme5linkSpeed: description: |- BIOS Token for setting NVME-5 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PcieSlotNvme5linkSpeed token. * `Disabled` - Value - Disabled for configuring PcieSlotNvme5linkSpeed token. * `GEN1` - Value - GEN1 for configuring PcieSlotNvme5linkSpeed token. * `GEN2` - Value - GEN2 for configuring PcieSlotNvme5linkSpeed token. * `GEN3` - Value - GEN3 for configuring PcieSlotNvme5linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true PcieSlotNvme5optionRom: description: |- BIOS Token for setting NVME-5 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PcieSlotNvme6linkSpeed: description: |- BIOS Token for setting NVME-6 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring PcieSlotNvme6linkSpeed token. * `Disabled` - Value - Disabled for configuring PcieSlotNvme6linkSpeed token. * `GEN1` - Value - GEN1 for configuring PcieSlotNvme6linkSpeed token. * `GEN2` - Value - GEN2 for configuring PcieSlotNvme6linkSpeed token. * `GEN3` - Value - GEN3 for configuring PcieSlotNvme6linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true PcieSlotNvme6optionRom: description: |- BIOS Token for setting NVME-6 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PopSupport: description: |- BIOS Token for setting Power ON Password configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true PostErrorPause: description: |- BIOS Token for setting POST Error Pause configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true ProcessorC1e: description: |- BIOS Token for setting Processor C1E configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true ProcessorC3report: description: |- BIOS Token for setting Processor C3 Report configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true ProcessorC6report: description: |- BIOS Token for setting Processor C6 Report configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true ProcessorCstate: description: |- BIOS Token for setting CPU C State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Psata: description: |- BIOS Token for setting P-SATA mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `AHCI` - Value - AHCI for configuring Psata token. * `Disabled` - Value - Disabled for configuring Psata token. * `LSI SW RAID` - Value - LSI SW RAID for configuring Psata token. type: string enum: - 'platform-default' - 'AHCI' - 'Disabled' - 'LSI SW RAID' default: platform-default x-omitempty: true PstateCoordType: description: |- BIOS Token for setting P-STATE Coordination configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `HW ALL` - Value - HW ALL for configuring PstateCoordType token. * `SW ALL` - Value - SW ALL for configuring PstateCoordType token. * `SW ANY` - Value - SW ANY for configuring PstateCoordType token. type: string enum: - 'platform-default' - 'HW ALL' - 'SW ALL' - 'SW ANY' default: platform-default x-omitempty: true PuttyKeyPad: description: |- BIOS Token for setting Putty KeyPad configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `ESCN` - Value - ESCN for configuring PuttyKeyPad token. * `LINUX` - Value - LINUX for configuring PuttyKeyPad token. * `SCO` - Value - SCO for configuring PuttyKeyPad token. * `VT100` - Value - VT100 for configuring PuttyKeyPad token. * `VT400` - Value - VT400 for configuring PuttyKeyPad token. * `XTERMR6` - Value - XTERMR6 for configuring PuttyKeyPad token. type: string enum: - 'platform-default' - 'ESCN' - 'LINUX' - 'SCO' - 'VT100' - 'VT400' - 'XTERMR6' default: platform-default x-omitempty: true PwrPerfTuning: description: |- BIOS Token for setting Power Performance Tuning configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `bios` - Value - BIOS for configuring PwrPerfTuning token. * `os` - Value - os for configuring PwrPerfTuning token. type: string enum: - 'platform-default' - 'bios' - 'os' default: platform-default x-omitempty: true QpiLinkFrequency: description: |- BIOS Token for setting QPI Link Frequency Select configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `6.4-gt/s` - Value - 6.4-gt/s for configuring QpiLinkFrequency token. * `7.2-gt/s` - Value - 7.2-gt/s for configuring QpiLinkFrequency token. * `8.0-gt/s` - Value - 8.0-gt/s for configuring QpiLinkFrequency token. * `9.6-gt/s` - Value - 9.6-gt/s for configuring QpiLinkFrequency token. * `auto` - Value - auto for configuring QpiLinkFrequency token. type: string enum: - 'platform-default' - '6.4-gt/s' - '7.2-gt/s' - '8.0-gt/s' - '9.6-gt/s' - 'auto' default: platform-default x-omitempty: true QpiLinkSpeed: description: |- BIOS Token for setting UPI Link Frequency Select configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `10.4GT/s` - Value - 10.4GT/s for configuring QpiLinkSpeed token. * `9.6GT/s` - Value - 9.6GT/s for configuring QpiLinkSpeed token. * `Auto` - Value - Auto for configuring QpiLinkSpeed token. type: string enum: - 'platform-default' - '10.4GT/s' - '9.6GT/s' - 'Auto' default: platform-default x-omitempty: true QpiSnoopMode: description: |- BIOS Token for setting QPI Snoop Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `auto` - Value - auto for configuring QpiSnoopMode token. * `cluster-on-die` - Value - cluster-on-die for configuring QpiSnoopMode token. * `early-snoop` - Value - early-snoop for configuring QpiSnoopMode token. * `home-directory-snoop` - Value - home-directory-snoop for configuring QpiSnoopMode token. * `home-directory-snoop-with-osb` - Value - home-directory-snoop-with-osb for configuring QpiSnoopMode token. * `home-snoop` - Value - home-snoop for configuring QpiSnoopMode token. type: string enum: - 'platform-default' - 'auto' - 'cluster-on-die' - 'early-snoop' - 'home-directory-snoop' - 'home-directory-snoop-with-osb' - 'home-snoop' default: platform-default x-omitempty: true RankInterLeave: description: |- BIOS Token for setting Rank Interleaving configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `1-way` - Value - 1-way for configuring RankInterLeave token. * `2-way` - Value - 2-way for configuring RankInterLeave token. * `4-way` - Value - 4-way for configuring RankInterLeave token. * `8-way` - Value - 8-way for configuring RankInterLeave token. * `auto` - Value - auto for configuring RankInterLeave token. type: string enum: - 'platform-default' - '1-way' - '2-way' - '4-way' - '8-way' - 'auto' default: platform-default x-omitempty: true RedirectionAfterPost: description: |- BIOS Token for setting Redirection After BIOS POST configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Always Enable` - Value - Always Enable for configuring RedirectionAfterPost token. * `Bootloader` - Value - Bootloader for configuring RedirectionAfterPost token. type: string enum: - 'platform-default' - 'Always Enable' - 'Bootloader' default: platform-default x-omitempty: true SataModeSelect: description: |- BIOS Token for setting SATA mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `AHCI` - Value - AHCI for configuring SataModeSelect token. * `Disabled` - Value - Disabled for configuring SataModeSelect token. * `LSI SW RAID` - Value - LSI SW RAID for configuring SataModeSelect token. type: string enum: - 'platform-default' - 'AHCI' - 'Disabled' - 'LSI SW RAID' default: platform-default x-omitempty: true SelectMemoryRasConfiguration: description: |- BIOS Token for setting SelectMemory RAS configuration configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `adddc-sparing` - Value - adddc-sparing for configuring SelectMemoryRasConfiguration token. * `lockstep` - Value - lockstep for configuring SelectMemoryRasConfiguration token. * `maximum-performance` - Value - maximum-performance for configuring SelectMemoryRasConfiguration token. * `mirror-mode-1lm` - Value - mirror-mode-1lm for configuring SelectMemoryRasConfiguration token. * `mirroring` - Value - mirroring for configuring SelectMemoryRasConfiguration token. * `partial-mirror-mode-1lm` - Value - partial-mirror-mode-1lm for configuring SelectMemoryRasConfiguration token. * `sparing` - Value - sparing for configuring SelectMemoryRasConfiguration token. type: string enum: - 'platform-default' - 'adddc-sparing' - 'lockstep' - 'maximum-performance' - 'mirror-mode-1lm' - 'mirroring' - 'partial-mirror-mode-1lm' - 'sparing' default: platform-default x-omitempty: true SelectPprType: description: |- BIOS Token for setting Select PPR Type configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring SelectPprType token. * `Hard PPR` - Value - Hard PPR for configuring SelectPprType token. type: string enum: - 'platform-default' - 'disabled' - 'Hard PPR' default: platform-default x-omitempty: true SerialPortAenable: description: |- BIOS Token for setting Serial A Enable configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SinglePctlEnable: description: |- BIOS Token for setting Single PCTL configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `No` - Value - No for configuring SinglePctlEnable token. * `Yes` - Value - Yes for configuring SinglePctlEnable token. type: string enum: - 'platform-default' - 'No' - 'Yes' default: platform-default x-omitempty: true Slot10linkSpeed: description: |- BIOS Token for setting PCIe Slot:10 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot10linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot10linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot10linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot10linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot10linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot10state: description: |- BIOS Token for setting Slot 10 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot10state token. * `enabled` - Value - enabled for configuring Slot10state token. * `Legacy Only` - Value - Legacy Only for configuring Slot10state token. * `UEFI Only` - Value - UEFI Only for configuring Slot10state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot11linkSpeed: description: |- BIOS Token for setting PCIe Slot:11 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot11linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot11linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot11linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot11linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot11linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot11state: description: |- BIOS Token for setting Slot 11 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Slot12linkSpeed: description: |- BIOS Token for setting PCIe Slot:12 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot12linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot12linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot12linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot12linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot12linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot12state: description: |- BIOS Token for setting Slot 12 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Slot13state: description: |- BIOS Token for setting PCIe Slot 13 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Slot14state: description: |- BIOS Token for setting PCIe Slot 14 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true Slot1linkSpeed: description: |- BIOS Token for setting PCIe Slot:1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot1linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot1linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot1linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot1linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot1linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot1state: description: |- BIOS Token for setting Slot 1 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot1state token. * `enabled` - Value - enabled for configuring Slot1state token. * `Legacy Only` - Value - Legacy Only for configuring Slot1state token. * `UEFI Only` - Value - UEFI Only for configuring Slot1state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot2linkSpeed: description: |- BIOS Token for setting PCIe Slot:2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot2linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot2linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot2linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot2linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot2linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot2state: description: |- BIOS Token for setting Slot 2 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot2state token. * `enabled` - Value - enabled for configuring Slot2state token. * `Legacy Only` - Value - Legacy Only for configuring Slot2state token. * `UEFI Only` - Value - UEFI Only for configuring Slot2state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot3linkSpeed: description: |- BIOS Token for setting PCIe Slot:3 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot3linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot3linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot3linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot3linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot3linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot3state: description: |- BIOS Token for setting Slot 3 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot3state token. * `enabled` - Value - enabled for configuring Slot3state token. * `Legacy Only` - Value - Legacy Only for configuring Slot3state token. * `UEFI Only` - Value - UEFI Only for configuring Slot3state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot4linkSpeed: description: |- BIOS Token for setting PCIe Slot:4 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot4linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot4linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot4linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot4linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot4linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot4state: description: |- BIOS Token for setting Slot 4 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot4state token. * `enabled` - Value - enabled for configuring Slot4state token. * `Legacy Only` - Value - Legacy Only for configuring Slot4state token. * `UEFI Only` - Value - UEFI Only for configuring Slot4state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot5linkSpeed: description: |- BIOS Token for setting PCIe Slot:5 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot5linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot5linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot5linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot5linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot5linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot5state: description: |- BIOS Token for setting Slot 5 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot5state token. * `enabled` - Value - enabled for configuring Slot5state token. * `Legacy Only` - Value - Legacy Only for configuring Slot5state token. * `UEFI Only` - Value - UEFI Only for configuring Slot5state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot6linkSpeed: description: |- BIOS Token for setting PCIe Slot:6 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot6linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot6linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot6linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot6linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot6linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot6state: description: |- BIOS Token for setting Slot 6 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot6state token. * `enabled` - Value - enabled for configuring Slot6state token. * `Legacy Only` - Value - Legacy Only for configuring Slot6state token. * `UEFI Only` - Value - UEFI Only for configuring Slot6state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot7linkSpeed: description: |- BIOS Token for setting PCIe Slot:7 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot7linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot7linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot7linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot7linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot7linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot7state: description: |- BIOS Token for setting Slot 7 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot7state token. * `enabled` - Value - enabled for configuring Slot7state token. * `Legacy Only` - Value - Legacy Only for configuring Slot7state token. * `UEFI Only` - Value - UEFI Only for configuring Slot7state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot8linkSpeed: description: |- BIOS Token for setting PCIe Slot:8 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot8linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot8linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot8linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot8linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot8linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot8state: description: |- BIOS Token for setting Slot 8 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot8state token. * `enabled` - Value - enabled for configuring Slot8state token. * `Legacy Only` - Value - Legacy Only for configuring Slot8state token. * `UEFI Only` - Value - UEFI Only for configuring Slot8state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true Slot9linkSpeed: description: |- BIOS Token for setting PCIe Slot:9 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Slot9linkSpeed token. * `Disabled` - Value - Disabled for configuring Slot9linkSpeed token. * `GEN1` - Value - GEN1 for configuring Slot9linkSpeed token. * `GEN2` - Value - GEN2 for configuring Slot9linkSpeed token. * `GEN3` - Value - GEN3 for configuring Slot9linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Slot9state: description: |- BIOS Token for setting Slot 9 State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring Slot9state token. * `enabled` - Value - enabled for configuring Slot9state token. * `Legacy Only` - Value - Legacy Only for configuring Slot9state token. * `UEFI Only` - Value - UEFI Only for configuring Slot9state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true SlotFlomLinkSpeed: description: |- BIOS Token for setting PCIe Slot:FLOM Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotFlomLinkSpeed token. * `Disabled` - Value - Disabled for configuring SlotFlomLinkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotFlomLinkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotFlomLinkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotFlomLinkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotFrontNvme1linkSpeed: description: |- BIOS Token for setting PCIe Slot:Front Nvme1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotFrontNvme1linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotFrontNvme1linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotFrontNvme1linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotFrontNvme1linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotFrontNvme1linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotFrontNvme2linkSpeed: description: |- BIOS Token for setting PCIe Slot:Front Nvme2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotFrontNvme2linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotFrontNvme2linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotFrontNvme2linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotFrontNvme2linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotFrontNvme2linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotFrontSlot5linkSpeed: description: |- BIOS Token for setting PCIe Slot:Front1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotFrontSlot5linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotFrontSlot5linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotFrontSlot5linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotFrontSlot5linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotFrontSlot5linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotFrontSlot6linkSpeed: description: |- BIOS Token for setting PCIe Slot:Front2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotFrontSlot6linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotFrontSlot6linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotFrontSlot6linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotFrontSlot6linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotFrontSlot6linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotGpu1state: description: |- BIOS Token for setting GPU1 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotGpu2state: description: |- BIOS Token for setting GPU2 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotGpu3state: description: |- BIOS Token for setting GPU3 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotGpu4state: description: |- BIOS Token for setting GPU4 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotGpu5state: description: |- BIOS Token for setting GPU5 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotGpu6state: description: |- BIOS Token for setting GPU6 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotGpu7state: description: |- BIOS Token for setting GPU7 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotGpu8state: description: |- BIOS Token for setting GPU8 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotHbaLinkSpeed: description: |- BIOS Token for setting PCIe Slot:HBA Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotHbaLinkSpeed token. * `Disabled` - Value - Disabled for configuring SlotHbaLinkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotHbaLinkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotHbaLinkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotHbaLinkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotHbaState: description: |- BIOS Token for setting PCIe Slot:HBA OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring SlotHbaState token. * `enabled` - Value - enabled for configuring SlotHbaState token. * `Legacy Only` - Value - Legacy Only for configuring SlotHbaState token. * `UEFI Only` - Value - UEFI Only for configuring SlotHbaState token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true SlotLom1link: description: |- BIOS Token for setting PCIe LOM:1 Link configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotLom2link: description: |- BIOS Token for setting PCIe LOM:2 Link configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotMezzState: description: |- BIOS Token for setting Slot Mezz State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring SlotMezzState token. * `enabled` - Value - enabled for configuring SlotMezzState token. * `Legacy Only` - Value - Legacy Only for configuring SlotMezzState token. * `UEFI Only` - Value - UEFI Only for configuring SlotMezzState token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true SlotMlomLinkSpeed: description: |- BIOS Token for setting PCIe Slot:MLOM Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotMlomLinkSpeed token. * `Disabled` - Value - Disabled for configuring SlotMlomLinkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotMlomLinkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotMlomLinkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotMlomLinkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotMlomState: description: |- BIOS Token for setting PCIe Slot MLOM OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring SlotMlomState token. * `enabled` - Value - enabled for configuring SlotMlomState token. * `Legacy Only` - Value - Legacy Only for configuring SlotMlomState token. * `UEFI Only` - Value - UEFI Only for configuring SlotMlomState token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true SlotMraidLinkSpeed: description: |- BIOS Token for setting MRAID Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotMraidLinkSpeed token. * `Disabled` - Value - Disabled for configuring SlotMraidLinkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotMraidLinkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotMraidLinkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotMraidLinkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotMraidState: description: |- BIOS Token for setting PCIe Slot MRAID OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN10state: description: |- BIOS Token for setting PCIe Slot N10 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN11state: description: |- BIOS Token for setting PCIe Slot N11 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN12state: description: |- BIOS Token for setting PCIe Slot N12 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN13state: description: |- BIOS Token for setting PCIe Slot N13 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN14state: description: |- BIOS Token for setting PCIe Slot N14 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN15state: description: |- BIOS Token for setting PCIe Slot N15 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN16state: description: |- BIOS Token for setting PCIe Slot N16 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN17state: description: |- BIOS Token for setting PCIe Slot N17 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN18state: description: |- BIOS Token for setting PCIe Slot N18 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN19state: description: |- BIOS Token for setting PCIe Slot N19 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN1state: description: |- BIOS Token for setting PCIe Slot N1 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring SlotN1state token. * `enabled` - Value - enabled for configuring SlotN1state token. * `Legacy Only` - Value - Legacy Only for configuring SlotN1state token. * `UEFI Only` - Value - UEFI Only for configuring SlotN1state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true SlotN20state: description: |- BIOS Token for setting PCIe Slot N20 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN21state: description: |- BIOS Token for setting PCIe Slot N21 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN22state: description: |- BIOS Token for setting PCIe Slot N22 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN23state: description: |- BIOS Token for setting PCIe Slot N23 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN24state: description: |- BIOS Token for setting PCIe Slot N24 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN2state: description: |- BIOS Token for setting PCIe Slot N2 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring SlotN2state token. * `enabled` - Value - enabled for configuring SlotN2state token. * `Legacy Only` - Value - Legacy Only for configuring SlotN2state token. * `UEFI Only` - Value - UEFI Only for configuring SlotN2state token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true SlotN3state: description: |- BIOS Token for setting PCIe Slot N3 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN4state: description: |- BIOS Token for setting PCIe Slot N4 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN5state: description: |- BIOS Token for setting PCIe Slot N5 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN6state: description: |- BIOS Token for setting PCIe Slot N6 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN7state: description: |- BIOS Token for setting PCIe Slot N7 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN8state: description: |- BIOS Token for setting PCIe Slot N8 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotN9state: description: |- BIOS Token for setting PCIe Slot N9 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRaidLinkSpeed: description: |- BIOS Token for setting RAID Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRaidLinkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRaidLinkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRaidLinkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRaidLinkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRaidLinkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRaidState: description: |- BIOS Token for setting PCIe Slot RAID OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme1linkSpeed: description: |- BIOS Token for setting PCIe Slot:Rear Nvme1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRearNvme1linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRearNvme1linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRearNvme1linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRearNvme1linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRearNvme1linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRearNvme1state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 1 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme2linkSpeed: description: |- BIOS Token for setting PCIe Slot:Rear Nvme2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRearNvme2linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRearNvme2linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRearNvme2linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRearNvme2linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRearNvme2linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRearNvme2state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 2 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme3state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 3 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme4state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 4 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme5state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 5 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme6state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 6 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme7state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 7 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRearNvme8state: description: |- BIOS Token for setting PCIe Slot:Rear NVME 8 OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SlotRiser1linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser1linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser1linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser1linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser1linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser1linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRiser1slot1linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser1 Slot1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser1slot1linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser1slot1linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser1slot1linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser1slot1linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser1slot1linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRiser1slot2linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser1 Slot2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser1slot2linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser1slot2linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser1slot2linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser1slot2linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser1slot2linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRiser1slot3linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser1 Slot3 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser1slot3linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser1slot3linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser1slot3linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser1slot3linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser1slot3linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRiser2linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser2linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser2linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser2linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser2linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser2linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRiser2slot4linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser2 Slot4 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser2slot4linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser2slot4linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser2slot4linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser2slot4linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser2slot4linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRiser2slot5linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser2 Slot5 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser2slot5linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser2slot5linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser2slot5linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser2slot5linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser2slot5linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotRiser2slot6linkSpeed: description: |- BIOS Token for setting PCIe Slot:Riser2 Slot6 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotRiser2slot6linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotRiser2slot6linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotRiser2slot6linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotRiser2slot6linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotRiser2slot6linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotSasState: description: |- BIOS Token for setting PCIe Slot:SAS OptionROM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `disabled` - Value - disabled for configuring SlotSasState token. * `enabled` - Value - enabled for configuring SlotSasState token. * `Legacy Only` - Value - Legacy Only for configuring SlotSasState token. * `UEFI Only` - Value - UEFI Only for configuring SlotSasState token. type: string enum: - 'platform-default' - 'disabled' - 'enabled' - 'Legacy Only' - 'UEFI Only' default: platform-default x-omitempty: true SlotSsdSlot1linkSpeed: description: |- BIOS Token for setting PCIe Slot:FrontSSD1 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotSsdSlot1linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotSsdSlot1linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotSsdSlot1linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotSsdSlot1linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotSsdSlot1linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true SlotSsdSlot2linkSpeed: description: |- BIOS Token for setting PCIe Slot:FrontSSD2 Link Speed configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SlotSsdSlot2linkSpeed token. * `Disabled` - Value - Disabled for configuring SlotSsdSlot2linkSpeed token. * `GEN1` - Value - GEN1 for configuring SlotSsdSlot2linkSpeed token. * `GEN2` - Value - GEN2 for configuring SlotSsdSlot2linkSpeed token. * `GEN3` - Value - GEN3 for configuring SlotSsdSlot2linkSpeed token. type: string enum: - 'platform-default' - 'Auto' - 'Disabled' - 'GEN1' - 'GEN2' - 'GEN3' default: platform-default x-omitempty: true Smee: description: |- BIOS Token for setting SMEE configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SmtMode: description: |- BIOS Token for setting SMT Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring SmtMode token. * `Off` - Value - Off for configuring SmtMode token. type: string enum: - 'platform-default' - 'Auto' - 'Off' default: platform-default x-omitempty: true Snc: description: |- BIOS Token for setting Sub Numa Clustering configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring Snc token. * `disabled` - Value - disabled for configuring Snc token. * `enabled` - Value - enabled for configuring Snc token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true SnoopyModeFor2lm: description: |- BIOS Token for setting Snoopy Mode for 2LM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SnoopyModeForAd: description: |- BIOS Token for setting Snoopy Mode for AD configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SparingMode: description: |- BIOS Token for setting Sparing Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `dimm-sparing` - Value - dimm-sparing for configuring SparingMode token. * `rank-sparing` - Value - rank-sparing for configuring SparingMode token. type: string enum: - 'platform-default' - 'dimm-sparing' - 'rank-sparing' default: platform-default x-omitempty: true SrIov: description: |- BIOS Token for setting SR-IOV Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true StreamerPrefetch: description: |- BIOS Token for setting DCU Streamer Prefetch configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true SvmMode: description: |- BIOS Token for setting SVM Mode configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true TerminalType: description: |- BIOS Token for setting Terminal Type configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `pc-ansi` - Value - pc-ansi for configuring TerminalType token. * `vt-utf8` - Value - vt-utf8 for configuring TerminalType token. * `vt100` - Value - vt100 for configuring TerminalType token. * `vt100-plus` - Value - vt100-plus for configuring TerminalType token. type: string enum: - 'platform-default' - 'pc-ansi' - 'vt-utf8' - 'vt100' - 'vt100-plus' default: platform-default x-omitempty: true TpmControl: description: |- BIOS Token for setting Trusted Platform Module State configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true TpmSupport: description: |- BIOS Token for setting TPM Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true TxtSupport: description: |- BIOS Token for setting Intel Trusted Execution Technology Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UcsmBootOrderRule: description: |- BIOS Token for setting Boot Order Rules configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Loose` - Value - Loose for configuring UcsmBootOrderRule token. * `Strict` - Value - Strict for configuring UcsmBootOrderRule token. type: string enum: - 'platform-default' - 'Loose' - 'Strict' default: platform-default x-omitempty: true UfsDisable: description: |- BIOS Token for setting Uncore Frequency Scaling configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbEmul6064: description: |- BIOS Token for setting Port 60/64 Emulation configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbPortFront: description: |- BIOS Token for setting USB Port Front configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbPortInternal: description: |- BIOS Token for setting USB Port Internal configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbPortKvm: description: |- BIOS Token for setting USB Port KVM configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbPortRear: description: |- BIOS Token for setting USB Port Rear configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbPortSdCard: description: |- BIOS Token for setting USB Port SD Card configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbPortVmedia: description: |- BIOS Token for setting USB Port VMedia configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true UsbXhciSupport: description: |- BIOS Token for setting XHCI Legacy Support configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true VgaPriority: description: |- BIOS Token for setting VGA Priority configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Offboard` - Value - Offboard for configuring VgaPriority token. * `Onboard` - Value - Onboard for configuring VgaPriority token. * `Onboard VGA Disabled` - Value - Onboard VGA Disabled for configuring VgaPriority token. type: string enum: - 'platform-default' - 'Offboard' - 'Onboard' - 'Onboard VGA Disabled' default: platform-default x-omitempty: true VmdEnable: description: |- BIOS Token for setting VMD Enablement configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `enabled` - Enables the BIOS setting. * `disabled` - Disables the BIOS setting. type: string enum: - 'platform-default' - 'enabled' - 'disabled' default: platform-default x-omitempty: true WorkLoadConfig: description: |- BIOS Token for setting Workload Configuration configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Balanced` - Value - Balanced for configuring WorkLoadConfig token. * `I/O Sensitive` - Value - I/O Sensitive for configuring WorkLoadConfig token. * `NUMA` - Value - NUMA for configuring WorkLoadConfig token. * `UMA` - Value - UMA for configuring WorkLoadConfig token. type: string enum: - 'platform-default' - 'Balanced' - 'I/O Sensitive' - 'NUMA' - 'UMA' default: platform-default x-omitempty: true XptPrefetch: description: |- BIOS Token for setting XPT Prefetch configuration. * `platform-default` - Default value used by the platform for the BIOS setting. * `Auto` - Value - Auto for configuring XptPrefetch token. * `disabled` - Value - disabled for configuring XptPrefetch token. * `enabled` - Value - enabled for configuring XptPrefetch token. type: string enum: - 'platform-default' - 'Auto' - 'disabled' - 'enabled' default: platform-default x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true bios.Policy.List: title: List of 'bios.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'bios.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'bios.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/bios.Policy' nullable: true bios.SystemBootOrder.Response: description: |- The response body of a HTTP GET request for the 'bios.SystemBootOrder' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'bios.SystemBootOrder' resources. x-one-of-name: bios.SystemBootOrder.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/bios.SystemBootOrder.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType bios.SystemBootOrder.Relationship: description: A relationship to the 'bios.SystemBootOrder' resource, or the expanded 'bios.SystemBootOrder' resource, or the 'null' value. x-one-of-name: bios.SystemBootOrder.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/bios.SystemBootOrder' bios.SystemBootOrder: title: Bios:System Boot Order description: |- Actual Boot Order of the system. x-allOf-name: bios.SystemBootOrder allOf: - # This 'bios.SystemBootOrder' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'bios.SystemBootOrder' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'bios.SystemBootOrder', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'bios.SystemBootOrder' ObjectType: enum: - 'bios.SystemBootOrder' BootMode: description: |- The BIOS boot mode. UEFI uses the GUID Partition Table (GPT) whereas Legacy mode uses the Master Boot Record (MBR) partitioning scheme. * `Legacy` - Legacy mode refers to the traditional process of booting from BIOS. Legacy mode uses the Master Boot Record (MBR) to locate the bootloader. * `Uefi` - UEFI mode uses the GUID Partition Table (GPT) to locate EFI Service Partitions to boot from. type: string enum: - 'Legacy' - 'Uefi' default: Legacy readOnly: true x-omitempty: true Dn: description: |- The Distinguished Name for this object, used to uniquely identify this object. type: string readOnly: true x-omitempty: true SecureBoot: description: |- Secure boot if set to enabled, enforces that device boots using only software that is trusted by the Original Equipment Manufacturer (OEM). * `Disabled` - Set the state of Secure Boot to Disabled. * `Enabled` - Set the state of Secure Boot to Enabled. type: string enum: - 'Disabled' - 'Enabled' default: Disabled readOnly: true x-omitempty: true BiosUnit: # A Relationship to MO bios.Unit $ref: '#/components/schemas/bios.Unit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a biosUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. BootDevices: # A Relationship to MO bios.BootDevice description: An array of relationships to biosBootDevice resources. type: array items: $ref: '#/components/schemas/bios.BootDevice.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true bios.SystemBootOrder.List: title: List of 'bios.SystemBootOrder' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'bios.SystemBootOrder' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'bios.SystemBootOrder' resources matching the request. type: array items: $ref: '#/components/schemas/bios.SystemBootOrder' nullable: true bios.Unit.Response: description: |- The response body of a HTTP GET request for the 'bios.Unit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'bios.Unit' resources. x-one-of-name: bios.Unit.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/bios.Unit.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType bios.Unit.Relationship: description: A relationship to the 'bios.Unit' resource, or the expanded 'bios.Unit' resource, or the 'null' value. x-one-of-name: bios.Unit.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/bios.Unit' bios.Unit: title: Bios:Unit description: |- The BIOS Unit present on a server. x-allOf-name: bios.Unit allOf: - # This 'bios.Unit' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'bios.Unit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'bios.Unit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'bios.Unit' ObjectType: enum: - 'bios.Unit' InitSeq: description: |- The initSeq of the equipment. type: string readOnly: true x-omitempty: true InitTs: description: |- The initTs of the equipment. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningFirmware: # A Relationship to MO firmware.RunningFirmware description: An array of relationships to firmwareRunningFirmware resources. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' nullable: true readOnly: true SystemBootOrder: # A Relationship to MO bios.SystemBootOrder $ref: '#/components/schemas/bios.SystemBootOrder.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a biosSystemBootOrder resource. When the $expand query parameter is specified, the referenced resource is returned inline. bios.Unit.List: title: List of 'bios.Unit' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'bios.Unit' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'bios.Unit' resources matching the request. type: array items: $ref: '#/components/schemas/bios.Unit' nullable: true boot.Bootloader: title: Boot:Bootloader description: |- Lists the bootloader properties that can be overriden for boot from Local disk and SAN boot. x-allOf-name: boot.Bootloader allOf: - # This 'boot.Bootloader' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'boot.Bootloader' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.Bootloader', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.Bootloader' ObjectType: enum: - 'boot.Bootloader' Description: description: |- Carries more information about the bootloader. type: string maxLength: 128 x-omitempty: true Name: description: |- Name of the bootloader image. type: string maxLength: 128 x-omitempty: true Path: description: |- Path to the bootloader image. type: string maxLength: 256 x-omitempty: true boot.DeviceBase: title: Boot:Device Base description: |- Lists properties that are common to all device types. It serves as base class for other device types. x-allOf-name: boot.DeviceBase allOf: - # This 'boot.DeviceBase' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'boot.DeviceBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.DeviceBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Enabled: description: |- Specifies if the boot device is enabled or disabled. type: boolean x-omitempty: true Name: description: |- A name that helps identify a boot device. It can be any string that adheres to the following constraints. It should start and end with an alphanumeric character. It can have underscores and hyphens. It cannot be more than 30 characters. type: string pattern: "((^[a-zA-Z0-9]$){1,30}|(^(([a-zA-Z0-9])([a-zA-Z0-9_\\-]{0,28})([a-zA-Z0-9]))$))" x-omitempty: true boot.DeviceBootMode.Response: description: |- The response body of a HTTP GET request for the 'boot.DeviceBootMode' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'boot.DeviceBootMode' resources. x-one-of-name: boot.DeviceBootMode.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/boot.DeviceBootMode.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType boot.DeviceBootMode.Relationship: description: A relationship to the 'boot.DeviceBootMode' resource, or the expanded 'boot.DeviceBootMode' resource, or the 'null' value. x-one-of-name: boot.DeviceBootMode.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/boot.DeviceBootMode' boot.DeviceBootMode: title: Boot:Device Boot Mode description: |- Boot mode of the devices that BIOS uses to boot them. x-allOf-name: boot.DeviceBootMode allOf: - # This 'boot.DeviceBootMode' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'boot.DeviceBootMode' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.DeviceBootMode', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.DeviceBootMode' ObjectType: enum: - 'boot.DeviceBootMode' ConfiguredBootMode: description: |- The user desired BIOS boot mode as configured in the boot policy. type: string x-omitempty: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true boot.DeviceBootMode.List: title: List of 'boot.DeviceBootMode' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'boot.DeviceBootMode' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'boot.DeviceBootMode' resources matching the request. type: array items: $ref: '#/components/schemas/boot.DeviceBootMode' nullable: true boot.Iscsi: title: iSCSI Boot description: |- Device type used when booting from iSCSI boot device. x-allOf-name: boot.Iscsi allOf: - # This 'boot.Iscsi' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.Iscsi' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.Iscsi', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.Iscsi' ObjectType: enum: - 'boot.Iscsi' Port: description: |- Port ID of the ISCSI boot device. type: integer format: int64 minimum: 0 maximum: 255 x-omitempty: true Slot: description: |- The slot id of the device. Supported values are (1 - 255, "MLOM", "L", "L1", "L2", "OCP"). type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|L|MLOM|L1|L2|OCP)$" x-omitempty: true boot.LocalCdd: title: Local CDD description: |- Device type used when booting from local CD drive. x-allOf-name: boot.LocalCdd allOf: - # This 'boot.LocalCdd' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' boot.LocalDisk: title: Local Disk description: |- Device type used when booting from a local disk device. x-allOf-name: boot.LocalDisk allOf: - # This 'boot.LocalDisk' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.LocalDisk' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.LocalDisk', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.LocalDisk' ObjectType: enum: - 'boot.LocalDisk' Bootloader: description: |- Details of the bootloader to be used during boot from local disk. $ref: '#/components/schemas/boot.Bootloader' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Slot: description: |- The slot id of the local disk device. Supported values are (1-255, "M", "HBA", "SAS", "RAID", "MRAID", "MSTOR-RAID"). type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|M|HBA|SAS|MRAID|RAID|MSTOR-RAID)$" x-omitempty: true boot.Nvme: title: NVMe description: |- Device type used when booting from a NVMe device. x-allOf-name: boot.Nvme allOf: - # This 'boot.Nvme' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.Nvme' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.Nvme', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.Nvme' ObjectType: enum: - 'boot.Nvme' Bootloader: description: |- Details of the bootloader to be used during SAN boot. $ref: '#/components/schemas/boot.Bootloader' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true boot.PchStorage: title: PCH Storage description: |- Device type used when booting from a PCH Storage device. x-allOf-name: boot.PchStorage allOf: - # This 'boot.PchStorage' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.PchStorage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.PchStorage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.PchStorage' ObjectType: enum: - 'boot.PchStorage' Bootloader: description: |- Details of the bootloader to be used during SAN boot. $ref: '#/components/schemas/boot.Bootloader' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Lun: description: |- The Logical Unit Number (LUN) of the device. It is the Virtual Drive number for Cisco UCS C-Series Servers. Virtual Drive number is found in storage inventory. type: integer format: int64 minimum: 0 maximum: 255 x-omitempty: true boot.PrecisionPolicy.Response: description: |- The response body of a HTTP GET request for the 'boot.PrecisionPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'boot.PrecisionPolicy' resources. x-one-of-name: boot.PrecisionPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/boot.PrecisionPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType boot.PrecisionPolicy: title: Boot Order description: |- Boot order policy models a reusable boot order configuration that can be applied to multiple servers via profile association. It supports advanced boot order configuration on Cisco CIMC servers. x-allOf-name: boot.PrecisionPolicy allOf: - # This 'boot.PrecisionPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'boot.PrecisionPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.PrecisionPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.PrecisionPolicy' ObjectType: enum: - 'boot.PrecisionPolicy' BootDevices: type: array items: description: |- Set of boot devices to be configured. $ref: '#/components/schemas/boot.DeviceBase' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 maxItems: 255 ConfiguredBootMode: description: |- Sets the BIOS boot mode. UEFI uses the GUID Partition Table (GPT) whereas Legacy mode uses the Master Boot Record (MBR) partitioning scheme. * `Legacy` - Legacy mode refers to the traditional process of booting from BIOS. Legacy mode uses the Master Boot Record (MBR) to locate the bootloader. * `Uefi` - UEFI mode uses the GUID Partition Table (GPT) to locate EFI Service Partitions to boot from. type: string enum: - 'Legacy' - 'Uefi' default: Legacy x-omitempty: true EnforceUefiSecureBoot: description: |- If UEFI secure boot is enabled, the boot mode is set to UEFI by default. Secure boot enforces that device boots using only software that is trusted by the Original Equipment Manufacturer (OEM). type: boolean x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true boot.PrecisionPolicy.List: title: List of 'boot.PrecisionPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'boot.PrecisionPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'boot.PrecisionPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/boot.PrecisionPolicy' nullable: true boot.Pxe: title: PXE Boot description: |- Device type used when booting from a PXE boot device. x-allOf-name: boot.Pxe allOf: - # This 'boot.Pxe' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.Pxe' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.Pxe', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.Pxe' ObjectType: enum: - 'boot.Pxe' InterfaceName: description: |- The name of the underlying virtual ethernet interface used by the PXE boot device. type: string pattern: "^[a-zA-Z0-9-._:]*$" x-omitempty: true InterfaceSource: description: |- Lists the supported Interface Source for PXE device. Supported values are "name" and "mac". * `name` - Use interface name to select virtual ethernet interface. * `mac` - Use MAC address to select virtual ethernet interface. * `port` - Use port to select virtual ethernet interface. type: string enum: - 'name' - 'mac' - 'port' default: name x-omitempty: true IpType: description: |- The IP Address family type to use during the PXE Boot process. * `None` - Default value if IpType is not specified. * `IPv4` - The IPv4 address family type. * `IPv6` - The IPv6 address family type. type: string enum: - 'None' - 'IPv4' - 'IPv6' default: None x-omitempty: true MacAddress: description: |- The MAC Address of the underlying virtual ethernet interface used by the PXE boot device. type: string pattern: "^$|^(((\\d|([a-f]|[A-F])){2}:){5}(\\d|([a-f]|[A-F])){2})$" x-omitempty: true Port: description: |- The Port ID of the adapter on which the underlying virtual ethernet interface is present. If no port is specified, the default value is -1. Supported values are -1 to 255. type: integer format: int64 minimum: -1 maximum: 255 x-omitempty: true Slot: description: |- The slot ID of the adapter on which the underlying virtual ethernet interface is present. Supported values are ( 1 - 255, "MLOM", "L", "L1", "L2", "OCP"). type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|L|MLOM|L1|L2|OCP)$" x-omitempty: true boot.San: title: SAN Boot description: |- Device type used when booting from SAN Boot device. x-allOf-name: boot.San allOf: - # This 'boot.San' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.San' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.San', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.San' ObjectType: enum: - 'boot.San' Bootloader: description: |- Details of the bootloader to be used during SAN boot. $ref: '#/components/schemas/boot.Bootloader' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Lun: description: |- The Logical Unit Number (LUN) of the device. type: integer format: int64 minimum: 0 maximum: 255 x-omitempty: true Slot: description: |- Slot ID of the device. Supported values are ( 1 - 255, "MLOM", "L1", "L2" ). type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|MLOM|L1|L2)$" x-omitempty: true boot.SdCard: title: SD Card description: |- Device type used when booting from SD Card device. x-allOf-name: boot.SdCard allOf: - # This 'boot.SdCard' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.SdCard' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.SdCard', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.SdCard' ObjectType: enum: - 'boot.SdCard' Bootloader: description: |- Details of the bootloader to be used during SAN boot. $ref: '#/components/schemas/boot.Bootloader' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Lun: description: |- The Logical Unit Number (LUN) of the device. type: integer format: int64 minimum: 0 maximum: 255 x-omitempty: true Subtype: description: |- The subtype for the selected device type. * `None` - No sub type for SD card boot device. * `flex-util` - Use of FlexUtil (microSD) card as sub type for SD card boot device. * `flex-flash` - Use of FlexFlash (SD) card as sub type for SD card boot device. * `SDCARD` - Use of SD card as sub type for the SD Card boot device. type: string enum: - 'None' - 'flex-util' - 'flex-flash' - 'SDCARD' default: None x-omitempty: true boot.UefiShell: title: UEFI Shell description: |- Device type used when booting from UEFI shell. x-allOf-name: boot.UefiShell allOf: - # This 'boot.UefiShell' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' boot.Usb: title: USB description: |- Device type used when booting from USB device. x-allOf-name: boot.Usb allOf: - # This 'boot.Usb' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.Usb' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.Usb', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.Usb' ObjectType: enum: - 'boot.Usb' Subtype: description: |- The subtype for the selected device type. * `None` - No sub type for USB boot device. * `usb-cd` - Use of Compact Disk (CD) as sub-type for the USB boot device. * `usb-fdd` - Use of Floppy Disk Drive (FDD) as sub-type for the USB boot device. * `usb-hdd` - Use of Hard Disk Drive (HDD) as sub-type for the USB boot device. type: string enum: - 'None' - 'usb-cd' - 'usb-fdd' - 'usb-hdd' default: None x-omitempty: true boot.VirtualMedia: title: Virtual Media description: |- Device type used when booting from Virtual Media device. x-allOf-name: boot.VirtualMedia allOf: - # This 'boot.VirtualMedia' class inherits all properties from its parent class boot.DeviceBase. $ref: '#/components/schemas/boot.DeviceBase' - # The definition of all the properties specified in this 'boot.VirtualMedia' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'boot.VirtualMedia', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'boot.VirtualMedia' ObjectType: enum: - 'boot.VirtualMedia' Subtype: description: |- The subtype for the selected device type. * `None` - No sub type for virtual media. * `cimc-mapped-dvd` - The virtual media device is mapped to a virtual DVD device. * `cimc-mapped-hdd` - The virtual media device is mapped to a virtual HDD device. * `kvm-mapped-dvd` - A KVM mapped DVD virtual media device. * `kvm-mapped-hdd` - A KVM mapped HDD virtual media device. * `kvm-mapped-fdd` - A KVM mapped FDD virtual media device. type: string enum: - 'None' - 'cimc-mapped-dvd' - 'cimc-mapped-hdd' - 'kvm-mapped-dvd' - 'kvm-mapped-hdd' - 'kvm-mapped-fdd' default: None x-omitempty: true capability.AdapterUnitDescriptor.Response: description: |- The response body of a HTTP GET request for the 'capability.AdapterUnitDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.AdapterUnitDescriptor' resources. x-one-of-name: capability.AdapterUnitDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.AdapterUnitDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.AdapterUnitDescriptor: title: Capability:Adapter Unit Descriptor description: |- Descriptor that uniquely identifies an adaptor. x-allOf-name: capability.AdapterUnitDescriptor allOf: - # This 'capability.AdapterUnitDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'capability.AdapterUnitDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.AdapterUnitDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.AdapterUnitDescriptor' ObjectType: enum: - 'capability.AdapterUnitDescriptor' ConnectivityOrder: description: |- Order in which the ports are connected; sequential or cyclic. type: string x-omitempty: true EthernetPortSpeed: description: |- The port speed for ethernet ports in Mbps. type: integer format: int64 x-omitempty: true FibreChannelPortSpeed: description: |- The port speed for fibre channel ports in Mbps. type: integer format: int64 x-omitempty: true NumDcePorts: description: |- Number of Dce Ports for the adaptor. type: integer format: int64 x-omitempty: true PromCardType: description: |- Prom card type for the adaptor. type: string x-omitempty: true capability.AdapterUnitDescriptor.List: title: List of 'capability.AdapterUnitDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.AdapterUnitDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.AdapterUnitDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/capability.AdapterUnitDescriptor' nullable: true capability.Capability.Relationship: description: A relationship to the 'capability.Capability' resource, or the expanded 'capability.Capability' resource, or the 'null' value. x-one-of-name: capability.Capability.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/capability.Capability' capability.Capability: title: Capability:Capability description: |- Abstract type that defines properties common for all capability descriptors. x-allOf-name: capability.Capability allOf: - # This 'capability.Capability' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'capability.Capability' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.Capability', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- An unique identifer for a capability descriptor. type: string x-omitempty: true Section: # A Relationship to MO capability.Section $ref: '#/components/schemas/capability.Section.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a capabilitySection resource. When the $expand query parameter is specified, the referenced resource is returned inline. capability.Catalog.Response: description: |- The response body of a HTTP GET request for the 'capability.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.Catalog' resources. x-one-of-name: capability.Catalog.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.Catalog.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.Catalog.Relationship: description: A relationship to the 'capability.Catalog' resource, or the expanded 'capability.Catalog' resource, or the 'null' value. x-one-of-name: capability.Catalog.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/capability.Catalog' capability.Catalog: title: Capability:Catalog description: |- Container for capability information of managed systems. This catalog will be managed by devops using a specific role in the Catalog Admin account. x-allOf-name: capability.Catalog allOf: - # This 'capability.Catalog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'capability.Catalog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.Catalog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.Catalog' ObjectType: enum: - 'capability.Catalog' Name: description: |- A unique name for the catalog. type: string x-createOnly: true x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Sections: # A Relationship to MO capability.Section description: An array of relationships to capabilitySection resources. type: array items: $ref: '#/components/schemas/capability.Section.Relationship' nullable: true capability.Catalog.List: title: List of 'capability.Catalog' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.Catalog' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.Catalog' resources matching the request. type: array items: $ref: '#/components/schemas/capability.Catalog' nullable: true capability.ChassisDescriptor.Response: description: |- The response body of a HTTP GET request for the 'capability.ChassisDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.ChassisDescriptor' resources. x-one-of-name: capability.ChassisDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.ChassisDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.ChassisDescriptor: title: Capability:Chassis Descriptor description: |- Descriptor that uniquely identifies an chassis enclosure. x-allOf-name: capability.ChassisDescriptor allOf: - # This 'capability.ChassisDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'capability.ChassisDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.ChassisDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.ChassisDescriptor' ObjectType: enum: - 'capability.ChassisDescriptor' Revision: description: |- Revision for the chassis enclosure. type: string x-omitempty: true capability.ChassisDescriptor.List: title: List of 'capability.ChassisDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.ChassisDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.ChassisDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/capability.ChassisDescriptor' nullable: true capability.ChassisManufacturingDef.Response: description: |- The response body of a HTTP GET request for the 'capability.ChassisManufacturingDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.ChassisManufacturingDef' resources. x-one-of-name: capability.ChassisManufacturingDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.ChassisManufacturingDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.ChassisManufacturingDef: title: Capability:Chassis Manufacturing Def description: |- Chassis enclosure manufacturing def properties. x-allOf-name: capability.ChassisManufacturingDef allOf: - # This 'capability.ChassisManufacturingDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.ChassisManufacturingDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.ChassisManufacturingDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.ChassisManufacturingDef' ObjectType: enum: - 'capability.ChassisManufacturingDef' Caption: description: |- Caption for Chassis enclosure. type: string x-omitempty: true ChassisCodeName: description: |- Chassis Code Name for Chassis enclosure. type: string x-omitempty: true Description: description: |- Description for Chassis enclosure. type: string x-omitempty: true Pid: description: |- Product Identifier for a Chassis enclosure. type: string x-omitempty: true ProductName: description: |- Product Name for Chassis enclosure. type: string x-omitempty: true Sku: description: |- SKU information for Chassis enclosure. type: string x-omitempty: true Vid: description: |- VID information for Chassis enclosure. type: string x-omitempty: true capability.ChassisManufacturingDef.List: title: List of 'capability.ChassisManufacturingDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.ChassisManufacturingDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.ChassisManufacturingDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.ChassisManufacturingDef' nullable: true capability.EndpointDescriptor: title: Capability:Endpoint Descriptor description: |- Abstract type that defines properties common for all endpoint descriptors. An endpoint descriptor is used to uniquely identify a type of endpoint. x-allOf-name: capability.EndpointDescriptor allOf: - # This 'capability.EndpointDescriptor' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'capability.EndpointDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.EndpointDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Detailed information about the endpoint. type: string x-omitempty: true Model: description: |- The model of the endpoint, for which this capability information is applicable. type: string x-omitempty: true Vendor: description: |- The vendor of the endpoint, for which this capability information is applicable. type: string x-omitempty: true Version: description: |- The firmware or software version of the endpoint, for which this capability information is applicable. type: string x-omitempty: true Capabilities: # A Relationship to MO capability.Capability description: An array of relationships to capabilityCapability resources. type: array items: $ref: '#/components/schemas/capability.Capability.Relationship' nullable: true Section: # A Relationship to MO capability.Section $ref: '#/components/schemas/capability.Section.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a capabilitySection resource. When the $expand query parameter is specified, the referenced resource is returned inline. capability.EquipmentPhysicalDef.Response: description: |- The response body of a HTTP GET request for the 'capability.EquipmentPhysicalDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.EquipmentPhysicalDef' resources. x-one-of-name: capability.EquipmentPhysicalDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.EquipmentPhysicalDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.EquipmentPhysicalDef: title: Capability:Equipment Physical Def description: |- Type to represent additional switch specific capabilities. x-allOf-name: capability.EquipmentPhysicalDef allOf: - # This 'capability.EquipmentPhysicalDef' class inherits all properties from its parent class capability.SwitchCapabilityDef. $ref: '#/components/schemas/capability.SwitchCapabilityDef' - # The definition of all the properties specified in this 'capability.EquipmentPhysicalDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.EquipmentPhysicalDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.EquipmentPhysicalDef' ObjectType: enum: - 'capability.EquipmentPhysicalDef' Depth: description: |- Depth information for a Switch/Fabric-Interconnect. type: number format: float x-omitempty: true Height: description: |- Height information for a Switch/Fabric-Interconnect. type: number format: float x-omitempty: true MaxPower: description: |- Max Power information for a Switch/Fabric-Interconnect. type: integer format: int64 x-omitempty: true MinPower: description: |- Min Power information for a Switch/Fabric-Interconnect. type: integer format: int64 x-omitempty: true NominalPower: description: |- Nominal Power information for a Switch/Fabric-Interconnect. type: integer format: int64 x-omitempty: true Weight: description: |- Weight information for a Switch/Fabric-Interconnect. type: number format: float x-omitempty: true Width: description: |- Width information for a Switch/Fabric-Interconnect. type: number format: float x-omitempty: true capability.EquipmentPhysicalDef.List: title: List of 'capability.EquipmentPhysicalDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.EquipmentPhysicalDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.EquipmentPhysicalDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.EquipmentPhysicalDef' nullable: true capability.EquipmentSlotArray.Response: description: |- The response body of a HTTP GET request for the 'capability.EquipmentSlotArray' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.EquipmentSlotArray' resources. x-one-of-name: capability.EquipmentSlotArray.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.EquipmentSlotArray.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.EquipmentSlotArray: title: Capability:Equipment Slot Array description: |- Type to represent additional switch specific capabilities. x-allOf-name: capability.EquipmentSlotArray allOf: - # This 'capability.EquipmentSlotArray' class inherits all properties from its parent class capability.SwitchCapabilityDef. $ref: '#/components/schemas/capability.SwitchCapabilityDef' - # The definition of all the properties specified in this 'capability.EquipmentSlotArray' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.EquipmentSlotArray', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.EquipmentSlotArray' ObjectType: enum: - 'capability.EquipmentSlotArray' FirstIndex: description: |- First Index information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true Height: description: |- Height information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true HorizontalStartOffset: description: |- Horizontal Start Offset information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true InlineGroupSeparation: description: |- Inline Group Separation information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true InlineGroupSize: description: |- Inline Group Size information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true InlineOffset: description: |- Inline Offset information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true Location: description: |- Location information for a Switch/Fabric-Interconnect hardware. type: string x-omitempty: true NumberOfSlots: description: |- Number of Slots information for a Switch/Fabric-Interconnect hardware. type: integer format: int64 x-omitempty: true Orientation: description: |- Orientation information for a Switch/Fabric-Interconnect hardware. type: string x-omitempty: true Selector: description: |- Selector information for a Switch/Fabric-Interconnect hardware. type: string x-omitempty: true SlotsPerLine: description: |- Slots per line information for a Switch/Fabric-Interconnect hardware. type: integer format: int64 x-omitempty: true TransverseGroupSeparation: description: |- Transverse Group Separation information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true TransverseGroupSize: description: |- Transverse Group Size information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true TransverseOffset: description: |- Transverse Offset information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true VerticalStartOffset: description: |- Vertical Start Offset information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true Width: description: |- Width information for a Switch/Fabric-Interconnect hardware. type: number format: float x-omitempty: true capability.EquipmentSlotArray.List: title: List of 'capability.EquipmentSlotArray' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.EquipmentSlotArray' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.EquipmentSlotArray' resources matching the request. type: array items: $ref: '#/components/schemas/capability.EquipmentSlotArray' nullable: true capability.FanModuleDescriptor.Response: description: |- The response body of a HTTP GET request for the 'capability.FanModuleDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.FanModuleDescriptor' resources. x-one-of-name: capability.FanModuleDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.FanModuleDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.FanModuleDescriptor: title: Capability:Fan Module Descriptor description: |- Descriptor that uniquely identifies a fan module. x-allOf-name: capability.FanModuleDescriptor allOf: - # This 'capability.FanModuleDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'capability.FanModuleDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.FanModuleDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.FanModuleDescriptor' ObjectType: enum: - 'capability.FanModuleDescriptor' Revision: description: |- Revision for the chassis enclosure. type: string x-omitempty: true capability.FanModuleDescriptor.List: title: List of 'capability.FanModuleDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.FanModuleDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.FanModuleDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/capability.FanModuleDescriptor' nullable: true capability.FanModuleManufacturingDef.Response: description: |- The response body of a HTTP GET request for the 'capability.FanModuleManufacturingDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.FanModuleManufacturingDef' resources. x-one-of-name: capability.FanModuleManufacturingDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.FanModuleManufacturingDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.FanModuleManufacturingDef: title: Capability:Fan Module Manufacturing Def description: |- Fan module unit that contains multiple fans. x-allOf-name: capability.FanModuleManufacturingDef allOf: - # This 'capability.FanModuleManufacturingDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.FanModuleManufacturingDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.FanModuleManufacturingDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.FanModuleManufacturingDef' ObjectType: enum: - 'capability.FanModuleManufacturingDef' Caption: description: |- Caption for a fan module. type: string x-omitempty: true Description: description: |- Description for a fan module. type: string x-omitempty: true Pid: description: |- Product Identifier for a fan module. type: string x-omitempty: true ProductName: description: |- Product Name for Fan Module Unit. type: string x-omitempty: true Sku: description: |- SKU information for a fan module. type: string x-omitempty: true Vid: description: |- VID information for a fan module. type: string x-omitempty: true capability.FanModuleManufacturingDef.List: title: List of 'capability.FanModuleManufacturingDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.FanModuleManufacturingDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.FanModuleManufacturingDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.FanModuleManufacturingDef' nullable: true capability.HardwareDescriptor: title: Capability:Hardware Descriptor description: |- Descriptor that uniquely identifies a hardware. x-allOf-name: capability.HardwareDescriptor allOf: - # This 'capability.HardwareDescriptor' class inherits all properties from its parent class capability.EndpointDescriptor. $ref: '#/components/schemas/capability.EndpointDescriptor' capability.IoCardCapabilityDef.Response: description: |- The response body of a HTTP GET request for the 'capability.IoCardCapabilityDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.IoCardCapabilityDef' resources. x-one-of-name: capability.IoCardCapabilityDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.IoCardCapabilityDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.IoCardCapabilityDef: title: Capability:Io Card Capability Def description: |- Chassis Iocard module capabilities. x-allOf-name: capability.IoCardCapabilityDef allOf: - # This 'capability.IoCardCapabilityDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.IoCardCapabilityDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.IoCardCapabilityDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.IoCardCapabilityDef' ObjectType: enum: - 'capability.IoCardCapabilityDef' DcSupported: description: |- Device connector support on Iocard. type: boolean x-omitempty: true capability.IoCardCapabilityDef.List: title: List of 'capability.IoCardCapabilityDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.IoCardCapabilityDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.IoCardCapabilityDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.IoCardCapabilityDef' nullable: true capability.IoCardDescriptor.Response: description: |- The response body of a HTTP GET request for the 'capability.IoCardDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.IoCardDescriptor' resources. x-one-of-name: capability.IoCardDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.IoCardDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.IoCardDescriptor: title: Capability:Io Card Descriptor description: |- Descriptor that uniquely identifies an IO card module. x-allOf-name: capability.IoCardDescriptor allOf: - # This 'capability.IoCardDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'capability.IoCardDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.IoCardDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.IoCardDescriptor' ObjectType: enum: - 'capability.IoCardDescriptor' NumHifPorts: description: |- Number of hif ports per blade for the iocard module. type: integer format: int64 x-omitempty: true Revision: description: |- Revision for the iocard module. type: string x-omitempty: true capability.IoCardDescriptor.List: title: List of 'capability.IoCardDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.IoCardDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.IoCardDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/capability.IoCardDescriptor' nullable: true capability.IoCardManufacturingDef.Response: description: |- The response body of a HTTP GET request for the 'capability.IoCardManufacturingDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.IoCardManufacturingDef' resources. x-one-of-name: capability.IoCardManufacturingDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.IoCardManufacturingDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.IoCardManufacturingDef: title: Capability:Io Card Manufacturing Def description: |- Chassis Iocard module properties. x-allOf-name: capability.IoCardManufacturingDef allOf: - # This 'capability.IoCardManufacturingDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.IoCardManufacturingDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.IoCardManufacturingDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.IoCardManufacturingDef' ObjectType: enum: - 'capability.IoCardManufacturingDef' Caption: description: |- Caption for a chassis Iocard module. type: string x-omitempty: true Description: description: |- Description for a chassis Iocard module. type: string x-omitempty: true Pid: description: |- Product Identifier for a chassis Iocard module. type: string x-omitempty: true ProductName: description: |- Product Name for IO Card Module. type: string x-omitempty: true Sku: description: |- SKU information for a chassis Iocard module. type: string x-omitempty: true Vid: description: |- VID information for a chassis Iocard module. type: string x-omitempty: true capability.IoCardManufacturingDef.List: title: List of 'capability.IoCardManufacturingDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.IoCardManufacturingDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.IoCardManufacturingDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.IoCardManufacturingDef' nullable: true capability.PortGroupAggregationDef.Response: description: |- The response body of a HTTP GET request for the 'capability.PortGroupAggregationDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.PortGroupAggregationDef' resources. x-one-of-name: capability.PortGroupAggregationDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.PortGroupAggregationDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.PortGroupAggregationDef: title: Capability:Port Group Aggregation Def description: |- FEX/IOCARD module port group aggregation capabilities. x-allOf-name: capability.PortGroupAggregationDef allOf: - # This 'capability.PortGroupAggregationDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.PortGroupAggregationDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.PortGroupAggregationDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.PortGroupAggregationDef' ObjectType: enum: - 'capability.PortGroupAggregationDef' AggregationCap: description: |- Aggregation capability for port group. type: string x-omitempty: true Hw40GPortGroupCap: description: |- Indicates support for 40G port group capability. type: boolean x-omitempty: true Pgtype: description: |- The type of port group for which this capability is defined. type: string x-omitempty: true capability.PortGroupAggregationDef.List: title: List of 'capability.PortGroupAggregationDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.PortGroupAggregationDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.PortGroupAggregationDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.PortGroupAggregationDef' nullable: true capability.PortRange: title: Capability:Port Range description: |- Type to represent ranges of ports supporting certain speeds or features on a switch. x-allOf-name: capability.PortRange allOf: - # This 'capability.PortRange' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'capability.PortRange' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.PortRange', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.PortRange' ObjectType: enum: - 'capability.PortRange' EndPortId: description: |- Ending Port ID in this range of ports. type: integer format: int64 x-omitempty: true EndSlotId: description: |- Ending Slot ID in this range of ports. type: integer format: int64 x-omitempty: true StartPortId: description: |- Starting Port ID in this range of ports. type: integer format: int64 x-omitempty: true StartSlotId: description: |- Starting Slot ID in this range of ports. type: integer format: int64 x-omitempty: true capability.PsuDescriptor.Response: description: |- The response body of a HTTP GET request for the 'capability.PsuDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.PsuDescriptor' resources. x-one-of-name: capability.PsuDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.PsuDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.PsuDescriptor: title: Capability:Psu Descriptor description: |- Descriptor that uniquely identifies a power supply. x-allOf-name: capability.PsuDescriptor allOf: - # This 'capability.PsuDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'capability.PsuDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.PsuDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.PsuDescriptor' ObjectType: enum: - 'capability.PsuDescriptor' Revision: description: |- Revision for the power supply. type: string x-omitempty: true capability.PsuDescriptor.List: title: List of 'capability.PsuDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.PsuDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.PsuDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/capability.PsuDescriptor' nullable: true capability.PsuManufacturingDef.Response: description: |- The response body of a HTTP GET request for the 'capability.PsuManufacturingDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.PsuManufacturingDef' resources. x-one-of-name: capability.PsuManufacturingDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.PsuManufacturingDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.PsuManufacturingDef: title: Capability:Psu Manufacturing Def description: |- Power supply unit properties. x-allOf-name: capability.PsuManufacturingDef allOf: - # This 'capability.PsuManufacturingDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.PsuManufacturingDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.PsuManufacturingDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.PsuManufacturingDef' ObjectType: enum: - 'capability.PsuManufacturingDef' Caption: description: |- Caption for a power supply unit. type: string x-omitempty: true Description: description: |- Description for a power supply unit. type: string x-omitempty: true Pid: description: |- Product Identifier for a power supply unit. type: string x-omitempty: true ProductName: description: |- Product Name for Power Supplu Unit. type: string x-omitempty: true Sku: description: |- SKU information for a power supply unit. type: string x-omitempty: true Vid: description: |- VID information for a power supply unit. type: string x-omitempty: true capability.PsuManufacturingDef.List: title: List of 'capability.PsuManufacturingDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.PsuManufacturingDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.PsuManufacturingDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.PsuManufacturingDef' nullable: true capability.Section.Response: description: |- The response body of a HTTP GET request for the 'capability.Section' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.Section' resources. x-one-of-name: capability.Section.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.Section.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.Section.Relationship: description: A relationship to the 'capability.Section' resource, or the expanded 'capability.Section' resource, or the 'null' value. x-one-of-name: capability.Section.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/capability.Section' capability.Section: title: Capability:Section description: |- Refers to a section in the capability catalog. A capability catalog is divided into sections which are managed independently. x-allOf-name: capability.Section allOf: - # This 'capability.Section' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'capability.Section' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.Section', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.Section' ObjectType: enum: - 'capability.Section' Action: description: |- Administrative action to initialize/load the catalog section from a particular source. * `None` - Nil value to indicate that no action is required. * `LoadLocal` - Load the catalog file packaged with the service. * `LoadIntersightRepository` - Load a catalog file hosted in the Intersight Repository. type: string enum: - 'None' - 'LoadLocal' - 'LoadIntersightRepository' default: None readOnly: true x-omitempty: true CatalogName: description: |- The catalog name reference. type: string x-createOnly: true x-omitempty: true Name: description: |- A unique name for the section inside a catalog. type: string x-createOnly: true x-omitempty: true Source: description: |- The configured source for this section of the catalog. * `Local` - The catalog file is packaged with the service. * `IntersightRepository` - The catalog file is hosted in the Intersight Repository. type: string enum: - 'Local' - 'IntersightRepository' default: Local readOnly: true x-omitempty: true Version: description: |- Version of the section inside a catalog. type: string x-omitempty: true Catalog: # A Relationship to MO capability.Catalog $ref: '#/components/schemas/capability.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a capabilityCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. capability.Section.List: title: List of 'capability.Section' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.Section' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.Section' resources matching the request. type: array items: $ref: '#/components/schemas/capability.Section' nullable: true capability.SiocModuleCapabilityDef.Response: description: |- The response body of a HTTP GET request for the 'capability.SiocModuleCapabilityDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.SiocModuleCapabilityDef' resources. x-one-of-name: capability.SiocModuleCapabilityDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.SiocModuleCapabilityDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.SiocModuleCapabilityDef: title: Capability:Sioc Module Capability Def description: |- Chassis SIOC module capabilities. x-allOf-name: capability.SiocModuleCapabilityDef allOf: - # This 'capability.SiocModuleCapabilityDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.SiocModuleCapabilityDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.SiocModuleCapabilityDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.SiocModuleCapabilityDef' ObjectType: enum: - 'capability.SiocModuleCapabilityDef' DcSupported: description: |- Device connector support on SIOC. type: boolean x-omitempty: true capability.SiocModuleCapabilityDef.List: title: List of 'capability.SiocModuleCapabilityDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.SiocModuleCapabilityDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.SiocModuleCapabilityDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.SiocModuleCapabilityDef' nullable: true capability.SiocModuleDescriptor.Response: description: |- The response body of a HTTP GET request for the 'capability.SiocModuleDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.SiocModuleDescriptor' resources. x-one-of-name: capability.SiocModuleDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.SiocModuleDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.SiocModuleDescriptor: title: Capability:Sioc Module Descriptor description: |- Descriptor that uniquely identifies an SIOC module. x-allOf-name: capability.SiocModuleDescriptor allOf: - # This 'capability.SiocModuleDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'capability.SiocModuleDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.SiocModuleDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.SiocModuleDescriptor' ObjectType: enum: - 'capability.SiocModuleDescriptor' Revision: description: |- Revision for the SIOC module. type: string x-omitempty: true capability.SiocModuleDescriptor.List: title: List of 'capability.SiocModuleDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.SiocModuleDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.SiocModuleDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/capability.SiocModuleDescriptor' nullable: true capability.SiocModuleManufacturingDef.Response: description: |- The response body of a HTTP GET request for the 'capability.SiocModuleManufacturingDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.SiocModuleManufacturingDef' resources. x-one-of-name: capability.SiocModuleManufacturingDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.SiocModuleManufacturingDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.SiocModuleManufacturingDef: title: Capability:Sioc Module Manufacturing Def description: |- Chassis SIOC module properties. x-allOf-name: capability.SiocModuleManufacturingDef allOf: - # This 'capability.SiocModuleManufacturingDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.SiocModuleManufacturingDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.SiocModuleManufacturingDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.SiocModuleManufacturingDef' ObjectType: enum: - 'capability.SiocModuleManufacturingDef' Caption: description: |- Caption for a chassis SIOC module. type: string x-omitempty: true Description: description: |- Description for a chassis SIOC module. type: string x-omitempty: true Pid: description: |- Product Identifier for a chassis SIOC module. type: string x-omitempty: true ProductName: description: |- Product Name for SIOC Module. type: string x-omitempty: true Sku: description: |- SKU information for a chassis SIOC module. type: string x-omitempty: true Vid: description: |- VID information for a chassis SIOC module. type: string x-omitempty: true capability.SiocModuleManufacturingDef.List: title: List of 'capability.SiocModuleManufacturingDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.SiocModuleManufacturingDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.SiocModuleManufacturingDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.SiocModuleManufacturingDef' nullable: true capability.SwitchCapability.Response: description: |- The response body of a HTTP GET request for the 'capability.SwitchCapability' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.SwitchCapability' resources. x-one-of-name: capability.SwitchCapability.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.SwitchCapability.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.SwitchCapability: title: Capability:Switch Capability description: |- Type to represent additional switch specific capabilities. x-allOf-name: capability.SwitchCapability allOf: - # This 'capability.SwitchCapability' class inherits all properties from its parent class capability.SwitchCapabilityDef. $ref: '#/components/schemas/capability.SwitchCapabilityDef' - # The definition of all the properties specified in this 'capability.SwitchCapability' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.SwitchCapability', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.SwitchCapability' ObjectType: enum: - 'capability.SwitchCapability' DefaultFcoeVlan: description: |- Default Fcoe VLAN associated with this switch. type: integer format: int64 x-omitempty: true DynamicVifsSupported: description: |- Dynamic VIFs support on this switch. type: boolean x-omitempty: true FanModulesSupported: description: |- Fan Modules support on this switch. type: boolean x-omitempty: true FcEndHostModeReservedVsans: type: array items: description: |- Collection of vsan ID ranges that are reserved when switch is in FC end-host mode. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true FcUplinkPortsAutoNegotiationSupported: description: |- Fc Uplink ports auto negotiation speed support on this switch. type: boolean x-omitempty: true LocatorBeaconSupported: description: |- Locator Beacon LED support on this switch. type: boolean x-omitempty: true MaxActiveSpanSessions: description: |- Maximum allowed Traffic Monitoring (SPAN) sessions on this switch. type: integer format: int64 x-omitempty: true MaxEthernetPortChannelMembers: description: |- Maximum allowed Ethernet Uplink Port-channel members for each Uplink Port-channel on this switch. type: integer format: int64 x-omitempty: true MaxEthernetPortChannels: description: |- Maximum allowed Ethernet Uplink Port-channels on this switch. type: integer format: int64 x-omitempty: true MaxEthernetUplinkPorts: description: |- Maximum allowed Ethernet Uplink Ports on this switch. type: integer format: int64 x-omitempty: true MaxFcFcoePortChannels: description: |- Total maximum Fc and Fcoe Port-channels allowed on this switch. type: integer format: int64 x-omitempty: true MaxFcPortChannelMembers: description: |- Maximum allowed FC Uplink Port-channel members for each FCoE Port-channel on this switch. type: integer format: int64 x-omitempty: true MaxFcoePortChannelMembers: description: |- Maximum allowed FCoE Uplink Port-channel members for each FCoE Port-channel on this switch. type: integer format: int64 x-omitempty: true MaxPorts: description: |- Maximum allowed physical ports on this switch. type: integer format: int64 x-omitempty: true MaxSlots: description: |- Maximum allowed physical slots on this switch. type: integer format: int64 x-omitempty: true MaxVsansSupported: description: |- Maximum number of Vsans supported on this switch. type: integer format: int64 x-omitempty: true MinActiveFans: description: |- Minimum number of fans needed to be active/running on this switch. type: integer format: int64 x-omitempty: true PortsSupporting100gSpeed: type: array items: description: |- Collection of port ranges that support 100 Gbps speed on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortsSupporting10gSpeed: type: array items: description: |- Collection of port ranges that support 10 Gbps speed on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortsSupporting1gSpeed: type: array items: description: |- Collection of port ranges that support 1 Gbps speed on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortsSupporting25gSpeed: type: array items: description: |- Collection of port ranges that support 25 Gbps speed on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortsSupporting40gSpeed: type: array items: description: |- Collection of port ranges that support 40 Gbps speed on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortsSupportingBreakout: type: array items: description: |- Collection of port ranges that support Breakout capability on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortsSupportingFcoe: type: array items: description: |- Collection of port ranges that support Fcoe on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortsSupportingServerRole: type: array items: description: |- Collection of port ranges that support Server role configuration on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ReservedVsans: type: array items: description: |- Collection of vsan ID ranges that are reserved on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SerenoNetflowSupported: description: |- Sereno Adaptor with Netflow support on this switch. type: boolean x-omitempty: true UnifiedPorts: type: array items: description: |- Range of ports that support Unified capability on this switch. $ref: '#/components/schemas/capability.PortRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true UnifiedRule: description: |- The Slider rule for Unified ports on this switch. type: string x-omitempty: true VpCompressionSupported: description: |- VP Compression support on this switch. type: boolean x-omitempty: true capability.SwitchCapability.List: title: List of 'capability.SwitchCapability' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.SwitchCapability' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.SwitchCapability' resources matching the request. type: array items: $ref: '#/components/schemas/capability.SwitchCapability' nullable: true capability.SwitchCapabilityDef: title: Capability:Switch Capability Def description: |- Abstract class that defines properties common for all Switch specific 'defs'. x-allOf-name: capability.SwitchCapabilityDef allOf: - # This 'capability.SwitchCapabilityDef' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'capability.SwitchCapabilityDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.SwitchCapabilityDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Pid: description: |- Product Identifier for a Switch/Fabric-Interconnect. type: string x-omitempty: true Sku: description: |- SKU information for Switch/Fabric-Interconnect. type: string x-omitempty: true Vid: description: |- VID information for Switch/Fabric-Interconnect. type: string x-omitempty: true capability.SwitchDescriptor.Response: description: |- The response body of a HTTP GET request for the 'capability.SwitchDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.SwitchDescriptor' resources. x-one-of-name: capability.SwitchDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.SwitchDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.SwitchDescriptor: title: Capability:Switch Descriptor description: |- Descriptor that uniquely identifies a Fabric interconnect. x-allOf-name: capability.SwitchDescriptor allOf: - # This 'capability.SwitchDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'capability.SwitchDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.SwitchDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.SwitchDescriptor' ObjectType: enum: - 'capability.SwitchDescriptor' ExpectedMemory: description: |- The total expected memory for this hardware. type: integer format: int64 x-omitempty: true Revision: description: |- Revision for the fabric interconnect. type: string x-omitempty: true capability.SwitchDescriptor.List: title: List of 'capability.SwitchDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.SwitchDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.SwitchDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/capability.SwitchDescriptor' nullable: true capability.SwitchManufacturingDef.Response: description: |- The response body of a HTTP GET request for the 'capability.SwitchManufacturingDef' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'capability.SwitchManufacturingDef' resources. x-one-of-name: capability.SwitchManufacturingDef.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/capability.SwitchManufacturingDef.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType capability.SwitchManufacturingDef: title: Capability:Switch Manufacturing Def description: |- Switch/Fabric-Interconnect manufacturing def properties. x-allOf-name: capability.SwitchManufacturingDef allOf: - # This 'capability.SwitchManufacturingDef' class inherits all properties from its parent class capability.SwitchCapabilityDef. $ref: '#/components/schemas/capability.SwitchCapabilityDef' - # The definition of all the properties specified in this 'capability.SwitchManufacturingDef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'capability.SwitchManufacturingDef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'capability.SwitchManufacturingDef' ObjectType: enum: - 'capability.SwitchManufacturingDef' Caption: description: |- Caption for Switch/Fabric-Interconnect. type: string x-omitempty: true Description: description: |- Description for Switch/Fabric-Interconnect. type: string x-omitempty: true PartNumber: description: |- Part Number for Switch/Fabric-Interconnect. type: string x-omitempty: true ProductName: description: |- Product Name for Switch/Fabric-Interconnect. type: string x-omitempty: true capability.SwitchManufacturingDef.List: title: List of 'capability.SwitchManufacturingDef' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'capability.SwitchManufacturingDef' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'capability.SwitchManufacturingDef' resources matching the request. type: array items: $ref: '#/components/schemas/capability.SwitchManufacturingDef' nullable: true cmrf.CmRf: title: Cmrf:Cm Rf description: |- A reference to a REST resource from a complex type, uniquely identified by object type and Moid. CMRF is a short term workaround until MoRef properties of complex types can be supported. CMRF means complex type managed object reference and is unique enough that it can be removed easily later. The long term solution is to support for relationships stanza under complextypes. Deprecated. x-allOf-name: cmrf.CmRf allOf: - # This 'cmrf.CmRf' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'cmrf.CmRf' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'cmrf.CmRf', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Moid: description: |- The Moid of the referenced REST resource. type: string readOnly: true x-omitempty: true ObjectType: description: |- The Object Type of the referenced REST resource. type: string readOnly: true x-omitempty: true comm.ConcreteCredential: title: Comm:Concrete Credential description: |- Credential common for most of the Managed Devices that require only username and password. x-allOf-name: comm.ConcreteCredential allOf: - # This 'comm.ConcreteCredential' class inherits all properties from its parent class comm.Credential. $ref: '#/components/schemas/comm.Credential' - # The definition of all the properties specified in this 'comm.ConcreteCredential' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'comm.ConcreteCredential', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'comm.ConcreteCredential' ObjectType: enum: - 'comm.ConcreteCredential' Name: description: |- Name for the credential entry that is created. type: string x-omitempty: true comm.Credential: title: Comm:Credential description: |- Base Credential for all the Managed Devices. x-allOf-name: comm.Credential allOf: - # This 'comm.Credential' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'comm.Credential' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'comm.Credential', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Password: description: |- Password for the Managed Device. type: string writeOnly: true x-omitempty: true Username: description: |- Username for the Managed Device. Format and restrictions are not enforced here but usually follow the ManagedDevice requirements. type: string x-omitempty: true comm.IpV4Interface: title: Comm:Ip V4 Interface description: |- The configuration data of a single IPv4 interface, including IP address, netmask, and default gateway. x-allOf-name: comm.IpV4Interface allOf: - # This 'comm.IpV4Interface' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'comm.IpV4Interface' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'comm.IpV4Interface', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'comm.IpV4Interface' ObjectType: enum: - 'comm.IpV4Interface' Gateway: description: |- The IPv4 address of the default gateway. type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true IpAddress: description: |- The IPv4 Address, represented in the standard dot-decimal notation, e.g. 192.168.1.3. 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]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true Netmask: description: |- The IPv4 Netmask, represented in the standard dot-decimal notation, e.g. 255.255.255.0. type: string pattern: "^$|^(((255.){3}(255|254|252|248|240|224|192|128|0+))|((255.){2}(255|254|252|248|240|224|192|128|0+).0)|((255.)(255|254|252|248|240|224|192|128|0+)(.0+){2})|((255|254|252|248|240|224|192|128|0+)(.0+){3}))$" x-omitempty: true comm.IpV6Interface: title: Comm:Ip V6 Interface description: |- The configuration data of a single IPv6 interface, including IP address, IPv6 prefix and default gateway. x-allOf-name: comm.IpV6Interface allOf: - # This 'comm.IpV6Interface' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'comm.IpV6Interface' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'comm.IpV6Interface', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'comm.IpV6Interface' ObjectType: enum: - 'comm.IpV6Interface' Gateway: description: |- The IPv6 address of the default gateway. type: string pattern: "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$" x-omitempty: true IpAddress: description: |- The IPv6 Address, represented as eight groups of four hexadecimal digits, separated by colons. type: string pattern: "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$" x-omitempty: true Prefix: description: |- The IPv6 Prefix, represented as eight groups of four hexadecimal digits, separated by colons. type: string x-omitempty: true comm.VmwareCredential: title: Comm:Vmware Credential description: |- Credential for VMware Managed Device. x-allOf-name: comm.VmwareCredential allOf: - # This 'comm.VmwareCredential' class inherits all properties from its parent class comm.Credential. $ref: '#/components/schemas/comm.Credential' - # The definition of all the properties specified in this 'comm.VmwareCredential' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'comm.VmwareCredential', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'comm.VmwareCredential' ObjectType: enum: - 'comm.VmwareCredential' Name: description: |- Name for the credential entry that is created. type: string x-omitempty: true compute.AlarmSummary: title: Compute:Alarm Summary description: |- The summary of alarm counts based on alarm serverity. x-allOf-name: compute.AlarmSummary allOf: - # This 'compute.AlarmSummary' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'compute.AlarmSummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.AlarmSummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.AlarmSummary' ObjectType: enum: - 'compute.AlarmSummary' Critical: description: |- The count of alarms that have severity type Critical. type: integer format: int64 x-omitempty: true Warning: description: |- The count of alarms that have severity type Warning. type: integer format: int64 x-omitempty: true compute.Blade.Response: description: |- The response body of a HTTP GET request for the 'compute.Blade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'compute.Blade' resources. x-one-of-name: compute.Blade.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/compute.Blade.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType compute.Blade.Relationship: description: A relationship to the 'compute.Blade' resource, or the expanded 'compute.Blade' resource, or the 'null' value. x-one-of-name: compute.Blade.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/compute.Blade' compute.Blade: title: Compute:Blade description: |- Server which is housed in a chassis and shares some of the hardware with other servers in the chassis. x-allOf-name: compute.Blade allOf: - # This 'compute.Blade' class inherits all properties from its parent class compute.Physical. $ref: '#/components/schemas/compute.Physical' - # The definition of all the properties specified in this 'compute.Blade' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.Blade', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.Blade' ObjectType: enum: - 'compute.Blade' ChassisId: description: |- The id of the chassis that the blade is located in. type: string readOnly: true x-omitempty: true ScaledMode: description: |- The mode of the server that determines it is scaled. type: string readOnly: true x-omitempty: true SlotId: description: |- The slot number in the chassis that the blade is located in. type: integer format: int64 readOnly: true x-omitempty: true Adapters: # A Relationship to MO adapter.Unit description: An array of relationships to adapterUnit resources. type: array items: $ref: '#/components/schemas/adapter.Unit.Relationship' nullable: true readOnly: true BiosUnits: # A Relationship to MO bios.Unit description: An array of relationships to biosUnit resources. type: array items: $ref: '#/components/schemas/bios.Unit.Relationship' nullable: true readOnly: true Bmc: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Board: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentIoExpanders: # A Relationship to MO equipment.IoExpander description: An array of relationships to equipmentIoExpander resources. type: array items: $ref: '#/components/schemas/equipment.IoExpander.Relationship' nullable: true readOnly: true GenericInventoryHolders: # A Relationship to MO inventory.GenericInventoryHolder description: An array of relationships to inventoryGenericInventoryHolder resources. type: array items: $ref: '#/components/schemas/inventory.GenericInventoryHolder.Relationship' nullable: true readOnly: true GraphicsCards: # A Relationship to MO graphics.Card description: An array of relationships to graphicsCard resources. type: array items: $ref: '#/components/schemas/graphics.Card.Relationship' nullable: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true LocatorLed: # A Relationship to MO equipment.LocatorLed $ref: '#/components/schemas/equipment.LocatorLed.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentLocatorLed resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryArrays: # A Relationship to MO memory.Array description: An array of relationships to memoryArray resources. type: array items: $ref: '#/components/schemas/memory.Array.Relationship' nullable: true PciDevices: # A Relationship to MO pci.Device description: An array of relationships to pciDevice resources. type: array items: $ref: '#/components/schemas/pci.Device.Relationship' nullable: true readOnly: true Processors: # A Relationship to MO processor.Unit description: An array of relationships to processorUnit resources. type: array items: $ref: '#/components/schemas/processor.Unit.Relationship' nullable: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageControllers: # A Relationship to MO storage.Controller description: An array of relationships to storageController resources. type: array items: $ref: '#/components/schemas/storage.Controller.Relationship' nullable: true StorageEnclosures: # A Relationship to MO storage.Enclosure description: An array of relationships to storageEnclosure resources. type: array items: $ref: '#/components/schemas/storage.Enclosure.Relationship' nullable: true readOnly: true TopSystem: # A Relationship to MO top.System $ref: '#/components/schemas/top.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a topSystem resource. When the $expand query parameter is specified, the referenced resource is returned inline. compute.Blade.List: title: List of 'compute.Blade' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'compute.Blade' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'compute.Blade' resources matching the request. type: array items: $ref: '#/components/schemas/compute.Blade' nullable: true compute.BladeIdentity.Response: description: |- The response body of a HTTP GET request for the 'compute.BladeIdentity' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'compute.BladeIdentity' resources. x-one-of-name: compute.BladeIdentity.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/compute.BladeIdentity.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType compute.BladeIdentity: title: Blade Server Identity Information description: |- Identity object that uniquely represents a blade server object under a DR. x-allOf-name: compute.BladeIdentity allOf: - # This 'compute.BladeIdentity' class inherits all properties from its parent class equipment.PhysicalIdentity. $ref: '#/components/schemas/equipment.PhysicalIdentity' - # The definition of all the properties specified in this 'compute.BladeIdentity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.BladeIdentity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.BladeIdentity' ObjectType: enum: - 'compute.BladeIdentity' ChassisId: description: |- Chassis Identifier of a blade server. type: integer format: int64 x-omitempty: true DeviceMoId: description: |- FI Device registration Mo ID. type: string x-omitempty: true PendingDiscovery: description: |- Indicates pending discovery flag. type: string x-omitempty: true SlotId: description: |- Chassis slot number of a blade server. type: integer format: int64 x-omitempty: true compute.BladeIdentity.List: title: List of 'compute.BladeIdentity' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'compute.BladeIdentity' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'compute.BladeIdentity' resources matching the request. type: array items: $ref: '#/components/schemas/compute.BladeIdentity' nullable: true compute.Board.Response: description: |- The response body of a HTTP GET request for the 'compute.Board' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'compute.Board' resources. x-one-of-name: compute.Board.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/compute.Board.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType compute.Board.Relationship: description: A relationship to the 'compute.Board' resource, or the expanded 'compute.Board' resource, or the 'null' value. x-one-of-name: compute.Board.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/compute.Board' compute.Board: title: Compute:Board description: |- Mother board of a server. x-allOf-name: compute.Board allOf: - # This 'compute.Board' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'compute.Board' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.Board', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.Board' ObjectType: enum: - 'compute.Board' BoardId: description: |- The identity of the motherboard. type: integer format: int64 readOnly: true x-omitempty: true CpuTypeController: description: |- The type of central processing unit on the mother board. type: string readOnly: true x-omitempty: true OperPowerState: description: |- Current power state of the mother board of the server. type: string readOnly: true x-omitempty: true Presence: description: |- Identifies the presence of the mother board of the server. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentTpms: # A Relationship to MO equipment.Tpm description: An array of relationships to equipmentTpm resources. type: array items: $ref: '#/components/schemas/equipment.Tpm.Relationship' nullable: true readOnly: true GraphicsCards: # A Relationship to MO graphics.Card description: An array of relationships to graphicsCard resources. type: array items: $ref: '#/components/schemas/graphics.Card.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryArrays: # A Relationship to MO memory.Array description: An array of relationships to memoryArray resources. type: array items: $ref: '#/components/schemas/memory.Array.Relationship' nullable: true readOnly: true PciCoprocessorCards: # A Relationship to MO pci.CoprocessorCard description: An array of relationships to pciCoprocessorCard resources. type: array items: $ref: '#/components/schemas/pci.CoprocessorCard.Relationship' nullable: true readOnly: true PciSwitch: # A Relationship to MO pci.Switch description: An array of relationships to pciSwitch resources. type: array items: $ref: '#/components/schemas/pci.Switch.Relationship' nullable: true readOnly: true PersistentMemoryConfiguration: # A Relationship to MO memory.PersistentMemoryConfiguration $ref: '#/components/schemas/memory.PersistentMemoryConfiguration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryPersistentMemoryConfiguration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Processors: # A Relationship to MO processor.Unit description: An array of relationships to processorUnit resources. type: array items: $ref: '#/components/schemas/processor.Unit.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true SecurityUnits: # A Relationship to MO security.Unit description: An array of relationships to securityUnit resources. type: array items: $ref: '#/components/schemas/security.Unit.Relationship' nullable: true readOnly: true StorageControllers: # A Relationship to MO storage.Controller description: An array of relationships to storageController resources. type: array items: $ref: '#/components/schemas/storage.Controller.Relationship' nullable: true readOnly: true StorageFlexFlashControllers: # A Relationship to MO storage.FlexFlashController description: An array of relationships to storageFlexFlashController resources. type: array items: $ref: '#/components/schemas/storage.FlexFlashController.Relationship' nullable: true readOnly: true StorageFlexUtilControllers: # A Relationship to MO storage.FlexUtilController description: An array of relationships to storageFlexUtilController resources. type: array items: $ref: '#/components/schemas/storage.FlexUtilController.Relationship' nullable: true readOnly: true compute.Board.List: title: List of 'compute.Board' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'compute.Board' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'compute.Board' resources matching the request. type: array items: $ref: '#/components/schemas/compute.Board' nullable: true compute.IpAddress: title: Compute:Ip Address description: |- Complex type representing an IP address in UCSM. x-allOf-name: compute.IpAddress allOf: - # This 'compute.IpAddress' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'compute.IpAddress' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.IpAddress', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.IpAddress' ObjectType: enum: - 'compute.IpAddress' Address: description: |- IP Address to be used for KVM. type: string readOnly: true x-omitempty: true Category: description: |- Category of the Kvm IP Address. * `Equipment` - Ip Address assigned to an equipment. * `ServiceProfile` - Ip Address assigned to a Service Profile. type: string enum: - 'Equipment' - 'ServiceProfile' default: Equipment readOnly: true x-omitempty: true DefaultGateway: description: |- Default gateway property of KVM IP Address. type: string readOnly: true x-omitempty: true Dn: description: |- The distinguished name for this managed object. type: string readOnly: true x-omitempty: true HttpPort: description: |- HTTP port of an IP Address. type: integer format: int64 readOnly: true x-omitempty: true HttpsPort: description: |- Secured HTTP port of an IP Address. type: integer format: int64 readOnly: true x-omitempty: true KvmPort: description: |- Port number on which the KVM is running and used for connecting to KVM console. type: integer format: int64 readOnly: true x-omitempty: true KvmVlan: description: |- VLAN Identifier of Inband IP Address. type: integer format: int64 readOnly: true x-omitempty: true Name: description: |- Name to identify the KVM IP Address. * `Outband` - The user assigned Out of band IP Address. * `Inband` - The user assigned Inband IP Address. type: string enum: - 'Outband' - 'Inband' default: Outband readOnly: true x-omitempty: true Subnet: description: |- Subnet detail of a KVM IP Address. type: string readOnly: true x-omitempty: true Type: description: |- Type of the KVM IP Address. * `MgmtInterface` - Ip Address of a Management Interface. * `VnicIpV4StaticAddr` - Static Ipv4 Address of a Virtual Network Interface. * `VnicIpV4PooledAddr` - Ipv4 Address of a Virtual Network Interface from an address pool. * `VnicIpV4MgmtPooledAddr` - Ipv4 Address of a Virtual Network Interface from a Managed address pool. * `VnicIpV6StaticAddr` - Static Ipv6 Address of a Virtual Network Interface. * `VnicIpV6MgmtPooledAddr` - Ipv6 Address of a Virtual Network Interface from a Managed address pool. * `VnicIpV4ProfDerivedAddr` - Server Profile derived Ipv4 Address of a Virtual Network Interface. type: string enum: - 'MgmtInterface' - 'VnicIpV4StaticAddr' - 'VnicIpV4PooledAddr' - 'VnicIpV4MgmtPooledAddr' - 'VnicIpV6StaticAddr' - 'VnicIpV6MgmtPooledAddr' - 'VnicIpV4ProfDerivedAddr' default: MgmtInterface readOnly: true x-omitempty: true compute.PersistentMemoryModule: title: Compute:Persistent Memory Module description: |- Persistent Memory Module on which an operation has to be performed. x-allOf-name: compute.PersistentMemoryModule allOf: - # This 'compute.PersistentMemoryModule' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'compute.PersistentMemoryModule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.PersistentMemoryModule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.PersistentMemoryModule' ObjectType: enum: - 'compute.PersistentMemoryModule' SocketId: description: |- Socket ID of the Persistent Memory Module on the server. type: string x-omitempty: true SocketMemoryId: description: |- Socket Memory ID of the Persistent Memory Module on the server. type: string x-omitempty: true compute.PersistentMemoryOperation: title: Compute:Persistent Memory Operation description: |- The operation that can be performed on the Persistent Memory Modules on the servers. x-allOf-name: compute.PersistentMemoryOperation allOf: - # This 'compute.PersistentMemoryOperation' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'compute.PersistentMemoryOperation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.PersistentMemoryOperation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.PersistentMemoryOperation' ObjectType: enum: - 'compute.PersistentMemoryOperation' AdminAction: description: |- Administrative actions that can be performed on the Persistent Memory Modules. * `None` - No action on the selected Persistent Memory Modules. * `SecureErase` - Secure Erase action on the selected Persistent Memory Modules. * `Unlock` - Unlock action on the selected Persistent Memory Modules. type: string enum: - 'None' - 'SecureErase' - 'Unlock' default: None x-omitempty: true IsSecurePassphraseSet: description: |- Indicates whether the value of the 'securePassphrase' property has been set. type: boolean readOnly: true x-omitempty: true Modules: type: array items: description: |- Selected Persistent Memory Modules on the server. $ref: '#/components/schemas/compute.PersistentMemoryModule' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SecurePassphrase: description: |- Secure passphrase of the Persistent Memory Modules of the server. type: string writeOnly: true x-omitempty: true compute.Physical.Relationship: description: A relationship to the 'compute.Physical' resource, or the expanded 'compute.Physical' resource, or the 'null' value. x-one-of-name: compute.Physical.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/compute.Physical' compute.Physical: title: Compute:Physical description: |- Abstract class for all physical servers. x-allOf-name: compute.Physical allOf: - # This 'compute.Physical' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'compute.Physical' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.Physical', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AdminPowerState: description: |- The desired power state of the server. type: string readOnly: true x-omitempty: true AlarmSummary: description: |- The summary of alarm counts based on the severity types (Critical or Warning). $ref: '#/components/schemas/compute.AlarmSummary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AssetTag: description: |- The user defined asset tag assigned to the server. type: string readOnly: true x-omitempty: true AvailableMemory: description: |- The amount of memory available on the server. type: integer format: int64 readOnly: true x-omitempty: true BiosPostComplete: description: |- The BIOS POST completion status of the server. type: boolean x-omitempty: true FaultSummary: description: |- The fault summary for the server. deprecated: true type: integer format: int64 x-omitempty: true KvmIpAddresses: type: array items: description: |- The list of KVM Ip addresses for the server. $ref: '#/components/schemas/compute.IpAddress' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ManagementMode: description: |- The management mode of the server. * `IntersightStandalone` - Intersight Standalone mode of operation. * `UCSM` - Unified Computing System Manager mode of operation. * `Intersight` - Intersight managed mode of operation. type: string enum: - 'IntersightStandalone' - 'UCSM' - 'Intersight' default: IntersightStandalone x-omitempty: true MemorySpeed: description: |- The maximum memory speed in MHz available on the server. type: string readOnly: true x-omitempty: true MgmtIpAddress: description: |- Management address of the server. type: string x-omitempty: true NumAdaptors: description: |- The total number of network adapters present on the server. type: integer format: int64 readOnly: true x-omitempty: true NumCpuCores: description: |- The total number of CPU cores present on the server. type: integer format: int64 readOnly: true x-omitempty: true NumCpuCoresEnabled: description: |- The total number of CPU cores enabled on the server. type: integer format: int64 readOnly: true x-omitempty: true NumCpus: description: |- The total number of CPUs present on the server. type: integer format: int64 readOnly: true x-omitempty: true NumEthHostInterfaces: description: |- The total number of vNICs which are visible to a host on the server. type: integer format: int64 readOnly: true x-omitempty: true NumFcHostInterfaces: description: |- The total number of vHBAs which are visible to a host on the server. type: integer format: int64 readOnly: true x-omitempty: true NumThreads: description: |- The total number of threads the server is capable of handling. type: integer format: int64 readOnly: true x-omitempty: true OperPowerState: description: |- The actual power state of the server. type: string readOnly: true x-omitempty: true OperState: description: |- The operational state of the server. type: string readOnly: true x-omitempty: true Operability: description: |- The operability of the server. type: string readOnly: true x-omitempty: true PlatformType: description: |- The platform type of the registered device - whether managed by UCSM or operating in standalone mode. type: string x-omitempty: true Presence: description: |- Indicates if a server is present in a slot and is applicable for blade servers. type: string readOnly: true x-omitempty: true ServiceProfile: description: |- The distinguished name of the service profile to which the server is associated to. It is applicable only for servers which are managed via UCSM. type: string readOnly: true x-omitempty: true TotalMemory: description: |- The total memory available on the server. type: integer format: int64 readOnly: true x-omitempty: true UserLabel: description: |- The user defined label assigned to the server. type: string readOnly: true x-omitempty: true Uuid: description: |- The universally unique identity of the server. type: string readOnly: true x-omitempty: true MgmtIdentity: # A Relationship to MO equipment.PhysicalIdentity $ref: '#/components/schemas/equipment.PhysicalIdentity.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentPhysicalIdentity resource. When the $expand query parameter is specified, the referenced resource is returned inline. compute.PhysicalSummary.Response: description: |- The response body of a HTTP GET request for the 'compute.PhysicalSummary' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'compute.PhysicalSummary' resources. x-one-of-name: compute.PhysicalSummary.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/compute.PhysicalSummary.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType compute.PhysicalSummary: title: Compute:Physical Summary description: |- Consolidated view of Blades and RackUnits. x-allOf-name: compute.PhysicalSummary allOf: - # This 'compute.PhysicalSummary' class inherits all properties from its parent class views.View. $ref: '#/components/schemas/views.View' - # The definition of all the properties specified in this 'compute.PhysicalSummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.PhysicalSummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.PhysicalSummary' ObjectType: enum: - 'compute.PhysicalSummary' AdminPowerState: description: |- The desired power state of the server. type: string readOnly: true x-omitempty: true AlarmSummary: description: |- The summary of alarm counts based on the severity types (Critical or Warning). $ref: '#/components/schemas/compute.AlarmSummary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true AssetTag: description: |- The user defined asset tag assigned to the server. type: string readOnly: true x-omitempty: true AvailableMemory: description: |- The amount of memory available on the server. type: integer format: int64 readOnly: true x-omitempty: true BiosPostComplete: description: |- The BIOS POST completion status of the server. type: boolean readOnly: true x-omitempty: true ChassisId: description: |- The id of the chassis that the blade is located in. type: string readOnly: true x-omitempty: true ConnectionStatus: description: |- Connectivity Status of RackUnit to Switch - A or B or AB. type: string readOnly: true x-omitempty: true CpuCapacity: description: |- CPU Capacity = Number of CPU Sockets x Enabled Cores x Speed (GHz). type: number format: float readOnly: true x-omitempty: true DeviceMoId: description: |- The database identifier of the registered device of an object. type: string readOnly: true x-omitempty: true Dn: description: |- The Distinguished Name unambiguously identifies an object in the system. type: string readOnly: true x-omitempty: true FaultSummary: description: |- The fault summary for the server. deprecated: true type: integer format: int64 readOnly: true x-omitempty: true Firmware: description: |- The firmware version of the Cisco Integrated Management Controller (CIMC) for this server. type: string readOnly: true x-omitempty: true Ipv4Address: description: |- The IPv4 address configured on the management interface of the Integrated Management Controller. type: string readOnly: true x-omitempty: true KvmIpAddresses: type: array items: description: |- The list of KVM Ip addresses for the server. $ref: '#/components/schemas/compute.IpAddress' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true ManagementMode: description: |- The management mode of the server. * `IntersightStandalone` - Intersight Standalone mode of operation. * `UCSM` - Unified Computing System Manager mode of operation. * `Intersight` - Intersight managed mode of operation. type: string enum: - 'IntersightStandalone' - 'UCSM' - 'Intersight' default: IntersightStandalone readOnly: true x-omitempty: true MemorySpeed: description: |- The maximum memory speed in MHz available on the server. type: string readOnly: true x-omitempty: true MgmtIpAddress: description: |- Management address of the server. type: string readOnly: true x-omitempty: true Model: description: |- This field identifies the model of the given component. type: string readOnly: true x-omitempty: true Name: description: |- The name of the UCS Fabric Interconnect cluster or Cisco Integrated Management Controller (CIMC). When this server is attached to a UCS Fabric Interconnect, the value of this property is the name of the UCS Fabric Interconnect. When this server configured in standalone mode, the value of this property is the name of the Cisco Integrated Management Controller. type: string readOnly: true x-omitempty: true NumAdaptors: description: |- The total number of network adapters present on the server. type: integer format: int64 readOnly: true x-omitempty: true NumCpuCores: description: |- The total number of CPU cores present on the server. type: integer format: int64 readOnly: true x-omitempty: true NumCpuCoresEnabled: description: |- The total number of CPU cores enabled on the server. type: integer format: int64 readOnly: true x-omitempty: true NumCpus: description: |- The total number of CPUs present on the server. type: integer format: int64 readOnly: true x-omitempty: true NumEthHostInterfaces: description: |- The total number of vNICs which are visible to a host on the server. type: integer format: int64 readOnly: true x-omitempty: true NumFcHostInterfaces: description: |- The total number of vHBAs which are visible to a host on the server. type: integer format: int64 readOnly: true x-omitempty: true NumThreads: description: |- The total number of threads the server is capable of handling. type: integer format: int64 readOnly: true x-omitempty: true OperPowerState: description: |- The actual power state of the server. type: string readOnly: true x-omitempty: true OperState: description: |- The operational state of the server. type: string readOnly: true x-omitempty: true Operability: description: |- The operability of the server. type: string readOnly: true x-omitempty: true PlatformType: description: |- The platform type of the registered device - whether managed by UCSM or operating in standalone mode. type: string readOnly: true x-omitempty: true Presence: description: |- Indicates if a server is present in a slot and is applicable for blade servers. type: string readOnly: true x-omitempty: true Revision: description: |- This field identifies the revision of the given component. type: string readOnly: true x-omitempty: true Rn: description: |- The Relative Name uniquely identifies an object within a given context. type: string readOnly: true x-omitempty: true ScaledMode: description: |- The mode of the server that determines it is scaled. type: string readOnly: true x-omitempty: true Serial: description: |- This field identifies the serial of the given component. type: string readOnly: true x-omitempty: true ServerId: description: |- RackUnit ID that uniquely identifies the server. type: integer format: int64 readOnly: true x-omitempty: true ServiceProfile: description: |- The distinguished name of the service profile to which the server is associated to. It is applicable only for servers which are managed via UCSM. type: string readOnly: true x-omitempty: true SlotId: description: |- The slot number in the chassis that the blade is located in. type: integer format: int64 readOnly: true x-omitempty: true SourceObjectType: description: |- The source object type of this view MO. type: string readOnly: true x-omitempty: true TopologyScanStatus: description: |- To maintain the Topology workflow run status. type: string readOnly: true x-omitempty: true TotalMemory: description: |- The total memory available on the server. type: integer format: int64 readOnly: true x-omitempty: true UserLabel: description: |- The user defined label assigned to the server. type: string readOnly: true x-omitempty: true Uuid: description: |- The universally unique identity of the server. type: string readOnly: true x-omitempty: true Vendor: description: |- This field identifies the vendor of the given component. type: string readOnly: true x-omitempty: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true compute.PhysicalSummary.List: title: List of 'compute.PhysicalSummary' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'compute.PhysicalSummary' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'compute.PhysicalSummary' resources matching the request. type: array items: $ref: '#/components/schemas/compute.PhysicalSummary' nullable: true compute.RackUnit.Response: description: |- The response body of a HTTP GET request for the 'compute.RackUnit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'compute.RackUnit' resources. x-one-of-name: compute.RackUnit.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/compute.RackUnit.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType compute.RackUnit.Relationship: description: A relationship to the 'compute.RackUnit' resource, or the expanded 'compute.RackUnit' resource, or the 'null' value. x-one-of-name: compute.RackUnit.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/compute.RackUnit' compute.RackUnit: title: Compute:Rack Unit description: |- Describes a standalone or FI-attached Rack-mounted server. x-allOf-name: compute.RackUnit allOf: - # This 'compute.RackUnit' class inherits all properties from its parent class compute.Physical. $ref: '#/components/schemas/compute.Physical' - # The definition of all the properties specified in this 'compute.RackUnit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.RackUnit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.RackUnit' ObjectType: enum: - 'compute.RackUnit' ConnectionStatus: description: |- Connectivity Status of RackUnit to Switch - A or B or AB. type: string readOnly: true x-omitempty: true ServerId: description: |- RackUnit ID that uniquely identifies the server. type: integer format: int64 readOnly: true x-omitempty: true TopologyScanStatus: description: |- To maintain the Topology workflow run status. type: string x-omitempty: true Adapters: # A Relationship to MO adapter.Unit description: An array of relationships to adapterUnit resources. type: array items: $ref: '#/components/schemas/adapter.Unit.Relationship' nullable: true readOnly: true BiosBootmode: # A Relationship to MO bios.BootMode $ref: '#/components/schemas/bios.BootMode.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a biosBootMode resource. When the $expand query parameter is specified, the referenced resource is returned inline. Biosunits: # A Relationship to MO bios.Unit description: An array of relationships to biosUnit resources. type: array items: $ref: '#/components/schemas/bios.Unit.Relationship' nullable: true readOnly: true Bmc: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Board: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true BootDeviceBootmode: # A Relationship to MO boot.DeviceBootMode $ref: '#/components/schemas/boot.DeviceBootMode.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a bootDeviceBootMode resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Fanmodules: # A Relationship to MO equipment.FanModule description: An array of relationships to equipmentFanModule resources. type: array items: $ref: '#/components/schemas/equipment.FanModule.Relationship' nullable: true readOnly: true GenericInventoryHolders: # A Relationship to MO inventory.GenericInventoryHolder description: An array of relationships to inventoryGenericInventoryHolder resources. type: array items: $ref: '#/components/schemas/inventory.GenericInventoryHolder.Relationship' nullable: true readOnly: true GraphicsCards: # A Relationship to MO graphics.Card description: An array of relationships to graphicsCard resources. type: array items: $ref: '#/components/schemas/graphics.Card.Relationship' nullable: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true LocatorLed: # A Relationship to MO equipment.LocatorLed $ref: '#/components/schemas/equipment.LocatorLed.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentLocatorLed resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryArrays: # A Relationship to MO memory.Array description: An array of relationships to memoryArray resources. type: array items: $ref: '#/components/schemas/memory.Array.Relationship' nullable: true PciDevices: # A Relationship to MO pci.Device description: An array of relationships to pciDevice resources. type: array items: $ref: '#/components/schemas/pci.Device.Relationship' nullable: true readOnly: true Processors: # A Relationship to MO processor.Unit description: An array of relationships to processorUnit resources. type: array items: $ref: '#/components/schemas/processor.Unit.Relationship' nullable: true Psus: # A Relationship to MO equipment.Psu description: An array of relationships to equipmentPsu resources. type: array items: $ref: '#/components/schemas/equipment.Psu.Relationship' nullable: true readOnly: true RackEnclosureSlot: # A Relationship to MO equipment.RackEnclosureSlot $ref: '#/components/schemas/equipment.RackEnclosureSlot.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentRackEnclosureSlot resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true SasExpanders: # A Relationship to MO storage.SasExpander description: An array of relationships to storageSasExpander resources. type: array items: $ref: '#/components/schemas/storage.SasExpander.Relationship' nullable: true StorageControllers: # A Relationship to MO storage.Controller description: An array of relationships to storageController resources. type: array items: $ref: '#/components/schemas/storage.Controller.Relationship' nullable: true StorageEnclosures: # A Relationship to MO storage.Enclosure description: An array of relationships to storageEnclosure resources. type: array items: $ref: '#/components/schemas/storage.Enclosure.Relationship' nullable: true readOnly: true TopSystem: # A Relationship to MO top.System $ref: '#/components/schemas/top.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a topSystem resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true compute.RackUnit.List: title: List of 'compute.RackUnit' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'compute.RackUnit' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'compute.RackUnit' resources matching the request. type: array items: $ref: '#/components/schemas/compute.RackUnit' nullable: true compute.RackUnitIdentity.Response: description: |- The response body of a HTTP GET request for the 'compute.RackUnitIdentity' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'compute.RackUnitIdentity' resources. x-one-of-name: compute.RackUnitIdentity.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/compute.RackUnitIdentity.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType compute.RackUnitIdentity: title: Rack Server Identity Information description: |- Identity object that uniquely represents a server object under a DR. x-allOf-name: compute.RackUnitIdentity allOf: - # This 'compute.RackUnitIdentity' class inherits all properties from its parent class equipment.PhysicalIdentity. $ref: '#/components/schemas/equipment.PhysicalIdentity' - # The definition of all the properties specified in this 'compute.RackUnitIdentity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.RackUnitIdentity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.RackUnitIdentity' ObjectType: enum: - 'compute.RackUnitIdentity' AdapterSerial: description: |- Serial Identifier of an adapter participating in SWM. type: string x-omitempty: true compute.RackUnitIdentity.List: title: List of 'compute.RackUnitIdentity' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'compute.RackUnitIdentity' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'compute.RackUnitIdentity' resources matching the request. type: array items: $ref: '#/components/schemas/compute.RackUnitIdentity' nullable: true compute.ServerConfig: title: Compute:Server Config description: |- Configurable properties of servers common to both a server and a server profile. The user will apply these properties on a server directly when the server is not associated with a server profile and through a server profile when the server is attached with a server profile. x-allOf-name: compute.ServerConfig allOf: - # This 'compute.ServerConfig' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'compute.ServerConfig' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.ServerConfig', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.ServerConfig' ObjectType: enum: - 'compute.ServerConfig' AssetTag: description: |- User defined asset tag of the server. type: string pattern: "^[ #$%\\(\\)\\*\\+,\\-\\./:;\\?@\\[\\]_\\{\\|\\}~a-zA-Z0-9]*$" minLength: 0 maxLength: 32 x-omitempty: true UserLabel: description: |- User defined description of the server. type: string pattern: "^[ !#$%&\\(\\)\\*\\+,\\-\\./:;\\?@\\[\\]_\\{\\|\\}~a-zA-Z0-9]*$" minLength: 0 maxLength: 64 x-omitempty: true compute.ServerSetting.Response: description: |- The response body of a HTTP GET request for the 'compute.ServerSetting' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'compute.ServerSetting' resources. x-one-of-name: compute.ServerSetting.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/compute.ServerSetting.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType compute.ServerSetting: title: Server Settings description: |- Models the configurable properties of a server in Intersight. x-allOf-name: compute.ServerSetting allOf: - # This 'compute.ServerSetting' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'compute.ServerSetting' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'compute.ServerSetting', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'compute.ServerSetting' ObjectType: enum: - 'compute.ServerSetting' AdminLocatorLedState: description: |- User configured state of the locator LED for the server. * `None` - No operation property for locator led. * `On` - The Locator Led is turned on. * `Off` - The Locator Led is turned off. type: string enum: - 'None' - 'On' - 'Off' default: None x-omitempty: true AdminPowerState: description: |- User configured power state of the server. * `Policy` - Power state is set to the default value in the policy. * `PowerOn` - Power state of the server is set to On. * `PowerOff` - Power state is the server set to Off. * `PowerCycle` - Power state the server is reset. * `HardReset` - Power state the server is hard reset. * `Shutdown` - Operating system on the server is shut down. * `Reboot` - Power state of IMC is rebooted. type: string enum: - 'Policy' - 'PowerOn' - 'PowerOff' - 'PowerCycle' - 'HardReset' - 'Shutdown' - 'Reboot' default: Policy x-omitempty: true ConfigState: description: |- The configured state of these settings in the target server. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target server. Applying - This state denotes that the settings are being applied in the target server. Failed - This state denotes that the settings could not be applied in the target server. * `Applied` - User configured settings are in applied state. * `Applying` - User settings are being applied on the target server. * `Failed` - User configured settings could not be applied. type: string enum: - 'Applied' - 'Applying' - 'Failed' default: Applied readOnly: true x-omitempty: true OneTimeBootDevice: description: |- The name of the device chosen by user for configuring One-Time Boot device. type: string x-omitempty: true PersistentMemoryOperation: description: |- The Persistent Memory Modules operation properties. $ref: '#/components/schemas/compute.PersistentMemoryOperation' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ServerConfig: description: |- The common server configurable properties between a server and a server profile. $ref: '#/components/schemas/compute.ServerConfig' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true LocatorLed: # A Relationship to MO equipment.LocatorLed $ref: '#/components/schemas/equipment.LocatorLed.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentLocatorLed resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningWorkflow: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Server: # A Relationship to MO compute.Physical $ref: '#/components/schemas/compute.Physical.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computePhysical resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true compute.ServerSetting.List: title: List of 'compute.ServerSetting' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'compute.ServerSetting' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'compute.ServerSetting' resources matching the request. type: array items: $ref: '#/components/schemas/compute.ServerSetting' nullable: true cond.Alarm.Response: description: |- The response body of a HTTP GET request for the 'cond.Alarm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- A state-full entity representing a found problem. Alarms can be reported by the managed system itself or can be determined by Intersight. x-allOf-name: cond.Alarm allOf: - # This 'cond.Alarm' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'cond.Alarm' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'cond.Alarm', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'cond.Alarm' ObjectType: enum: - 'cond.Alarm' Acknowledge: description: |- Alarm acknowledgment state. Default value is None. * `None` - The Enum value None represents that the alarm is not acknowledged and is included as part of health status and overall alarm count. * `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 AffectedMoId: description: |- MoId of the affected object from the managed system's point of view. type: string readOnly: true x-omitempty: true AffectedMoType: description: |- Managed system affected object type. For example Adaptor, FI, CIMC. 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. type: string readOnly: true x-omitempty: true AncestorMoId: description: |- Parent MoId of the fault from managed system. For example, Blade moid for adaptor fault. type: string readOnly: true x-omitempty: true AncestorMoType: description: |- Parent MO type of the fault from managed system. For example, Blade for adaptor fault. 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 LastTransitionTime: description: |- The time the alarm last had a change in severity. type: string format: date-time 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. * `None` - The Enum value None represents that there is no severity. * `Info` - The Enum value Info represents the Informational level of severity. * `Critical` - The Enum value Critical represents the Critical level of severity. * `Warning` - The Enum value Warning represents the Warning level of severity. * `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. * `None` - The Enum value None represents that there is no severity. * `Info` - The Enum value Info represents the Informational level of severity. * `Critical` - The Enum value Critical represents the Critical level of severity. * `Warning` - The Enum value Warning represents the Warning level of severity. * `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 RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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. The '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.AlarmAggregation.Response: description: |- The response body of a HTTP GET request for the 'cond.AlarmAggregation' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Object which represents alarm aggregation for a managed end point. x-allOf-name: cond.AlarmAggregation allOf: - # This 'cond.AlarmAggregation' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'cond.AlarmAggregation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'cond.AlarmAggregation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'cond.AlarmAggregation' ObjectType: enum: - 'cond.AlarmAggregation' AlarmSummary: description: |- The summary of alarm counts based on the severity types (Critical or Warning). $ref: '#/components/schemas/cond.AlarmSummary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true CriticalAlarmsCount: description: |- Count of all alarms with severity Critical, irrespective of acknowledgement status. type: integer format: int64 x-omitempty: true Health: description: |- Health of the managed end point. The highest severity computed from alarmSummary property is set as the health. * `None` - The Enum value None represents that there is no severity. * `Info` - The Enum value Info represents the Informational level of severity. * `Critical` - The Enum value Critical represents the Critical level of severity. * `Warning` - The Enum value Warning represents the Warning level of severity. * `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 InfoAlarmsCount: description: |- Count of all alarms with severity Info, irrespective of acknowledgement status. type: integer format: int64 x-omitempty: true MoType: description: |- Managed object type. For example, FI managed object type will be network.Element. type: string x-omitempty: true WarningAlarmsCount: description: |- Count of all alarms with severity Warning, irrespective of acknowledgement status. type: integer format: int64 x-omitempty: true AlarmAggregationSource: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When 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. The '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.AlarmSummary: title: Cond:Alarm Summary description: |- The summary of alarm counts based on alarm serverity. x-allOf-name: cond.AlarmSummary allOf: - # This 'cond.AlarmSummary' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'cond.AlarmSummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'cond.AlarmSummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'cond.AlarmSummary' ObjectType: enum: - 'cond.AlarmSummary' Critical: description: |- The count of alarms that have severity type Critical. type: integer format: int64 x-omitempty: true Warning: description: |- The count of alarms that have severity type Warning. type: integer format: int64 x-omitempty: true cond.HclStatus.Response: description: |- The response body of a HTTP GET request for the 'cond.HclStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' cond.HclStatus: title: Cond:Hcl Status description: |- The HCL status of a managed object after we have validated the managed object components' firmware and drivers against the HCL. x-allOf-name: cond.HclStatus allOf: - # This 'cond.HclStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'cond.HclStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'cond.HclStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'cond.HclStatus' ObjectType: enum: - 'cond.HclStatus' 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. * `Incomplete` - This means we do not have os information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that his component's hardware or software profile was not found in the HCL. * `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. * `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. * `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. 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. type: string enum: - 'Incomplete' - 'Not-Found' - 'Not-Listed' - 'Validated' - 'Not-Evaluated' default: Incomplete 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. * `Incomplete` - This means we do not have os information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that his component's hardware or software profile was not found in the HCL. * `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. * `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. * `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. 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. type: string enum: - 'Incomplete' - 'Not-Found' - 'Not-Listed' - 'Validated' - 'Not-Evaluated' default: Incomplete 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 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 x-omitempty: true HclOsVendor: description: |- The OS Vendor for the managed object to validate normalized for querying HCL data. It is empty if we are missing this information. type: string x-omitempty: true HclOsVersion: description: |- The OS Version for the managed object to validate normalized for querying HCL data. It is empty if we are missing this information. type: string 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 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 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 x-omitempty: true InvOsVendor: description: |- The OS Vendor for the managed object to validate as received from inventory. It is empty if we are missing this information. type: string x-omitempty: true InvOsVersion: description: |- The OS Version for the managed object to validate as received from inventory. It is empty if we are missing this information. type: string 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 x-omitempty: true Reason: description: |- The reason for the HCL status. It will be one of the following "Missing-Os-Info" - we are missing os 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. * `Missing-Os-Info` - This means the HclStatus for the sever failed HCL validation because we have missing os information. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Incompatible-Components` - This means the HclStatus for the sever failed HCL validation because one or more of its components failed validation. To see why components failed check the related HclStatusDetails. * `Compatible` - This means the HclStatus for the sever has passed HCL validation for all of its related components. * `Not-Evaluated` - This means the HclStatus for the sever has not been evaluated because it is exempted. type: string enum: - 'Missing-Os-Info' - 'Incompatible-Components' - 'Compatible' - 'Not-Evaluated' default: Missing-Os-Info 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 os vendor and version is not listed in HCL with the HW profile. "Incompatible-Os-Info" - the os 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. * `Missing-Os-Driver-Info` - The validation failed becaue the given server has no OS driver information available in the inventory. Either install UCS Tools VIB on the host ESXi or use OS Discovery Tool scripts to provide proper OS information. * `Incompatible-Server` - The validation failed for this server because the server's model was not listed in the HCL. * `Incompatible-Processor` - The validation failed because the given processor was not listed for the given server model. * `Incompatible-Os-Info` - The validation failed because the given OS vendor or version was not listed in HCL for the server PID and processor combination. * `Incompatible-Firmware` - The validation failed because the given server firmware was not listed in the HCL for the given server PID, processor, OS vendor and version. * `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. * `Service-Error` - The validation has failed because the HCL data service has returned a service error or unrecognized result. * `Not-Evaluated` - This means the HclStatus for the sever has not been evaluated because it is exempted. * `Incompatible-Components` - The validation has failed for this server because one or more components have "Not-Listed" status. * `Compatible` - The validation has passed for this server's model, processor, OS 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 x-omitempty: true SoftwareStatus: description: |- The OS 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 os vendor/version is listed in the HCL for the server model, processor and firmware "Not-Listed" - The os vendor/version is not listed in the HCL for the server model, processor and firmware "Incomplete" - The inventory is missing os vendor/version and HCL validation was not performed. "Not-Evaluated" - The server is not evaluated against the HCL because it is exempted. * `Incomplete` - This means we do not have os information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that his component's hardware or software profile was not found in the HCL. * `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. * `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. * `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. 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. type: string enum: - 'Incomplete' - 'Not-Found' - 'Not-Listed' - 'Validated' - 'Not-Evaluated' default: Incomplete 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. * `Incomplete` - This means we do not have os information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that his component's hardware or software profile was not found in the HCL. * `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. * `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. * `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. 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. type: string enum: - 'Incomplete' - 'Not-Found' - 'Not-Listed' - 'Validated' - 'Not-Evaluated' default: Incomplete x-omitempty: true Details: # A Relationship to MO cond.HclStatusDetail description: An array of relationships to condHclStatusDetail resources. type: array items: $ref: '#/components/schemas/cond.HclStatusDetail.Relationship' nullable: true readOnly: true ManagedObject: # A Relationship to MO inventory.Base $ref: '#/components/schemas/inventory.Base.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' cond.HclStatusDetail: title: Cond:Hcl Status Detail description: |- The HCL status detail for each component firmware and driver. x-allOf-name: cond.HclStatusDetail allOf: - # This 'cond.HclStatusDetail' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'cond.HclStatusDetail' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'cond.HclStatusDetail', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'cond.HclStatusDetail' ObjectType: enum: - 'cond.HclStatusDetail' 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 evaulated 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. * `Missing-Os-Driver-Info` - The validation failed becaue the given server has no OS driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL. * `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID. * `Incompatible-Os-Info` - The validation failed because the given OS vendor and version was not found in HCL for the server PID and processor combination. * `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 OS vendor and version. * `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, OS vendor and version and component model. * `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, OS vendor and version, server firmware and component firmware. * `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, OS vendor and version and server firmware. * `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. * `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result. * `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. * `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. * `Compatible` - The validation has passed for this server PID, processor, OS 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 x-omitempty: true HclCimcVersion: description: |- The current CIMC version for the server normalized for querying HCL data. type: string x-omitempty: true HclDriverName: description: |- The current driver name of the component we are validating normalized for querying HCL data. type: string x-omitempty: true HclDriverVersion: description: |- The current driver version of the component we are validating normalized for querying HCL data. type: string x-omitempty: true HclFirmwareVersion: description: |- The current firmware version of the component model normalized for querying HCL data. type: string x-omitempty: true HclModel: description: |- The component model we are trying to validate normalized for querying HCL data. type: string x-omitempty: true InvCimcVersion: description: |- The current CIMC version for the server as received from inventory. type: string x-omitempty: true InvDriverName: description: |- The current driver name of the component we are validating as received from inventory. type: string x-omitempty: true InvDriverVersion: description: |- The current driver version of the component we are validating as received from inventory. type: string x-omitempty: true InvFirmwareVersion: description: |- The current firmware version of the component model as received from inventory. type: string x-omitempty: true InvModel: description: |- The component model we are trying to validate as received from inventory. type: string 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 os 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 os 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 occured 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. * `Missing-Os-Driver-Info` - The validation failed becaue the given server has no OS driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL. * `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID. * `Incompatible-Os-Info` - The validation failed because the given OS vendor and version was not found in HCL for the server PID and processor combination. * `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 OS vendor and version. * `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, OS vendor and version and component model. * `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, OS vendor and version, server firmware and component firmware. * `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, OS vendor and version and server firmware. * `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. * `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result. * `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. * `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. * `Compatible` - The validation has passed for this server PID, processor, OS 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 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. * `Missing-Os-Driver-Info` - The validation failed becaue the given server has no OS driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL. * `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID. * `Incompatible-Os-Info` - The validation failed because the given OS vendor and version was not found in HCL for the server PID and processor combination. * `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 OS vendor and version. * `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, OS vendor and version and component model. * `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, OS vendor and version, server firmware and component firmware. * `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, OS vendor and version and server firmware. * `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. * `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result. * `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. * `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. * `Compatible` - The validation has passed for this server PID, processor, OS 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 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. * `Incomplete` - This means we do not have os information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper OS information. * `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that his component's hardware or software profile was not found in the HCL. * `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. * `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. * `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. 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. type: string enum: - 'Incomplete' - 'Not-Found' - 'Not-Listed' - 'Validated' - 'Not-Evaluated' default: Incomplete x-omitempty: true Component: # A Relationship to MO inventory.Base $ref: '#/components/schemas/inventory.Base.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true HclStatus: # A Relationship to MO cond.HclStatus $ref: '#/components/schemas/cond.HclStatus.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a condHclStatus resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- An HCLStatusJob is used to batch mo inventory notifications and process the evaluation of HCLStatus. When we receive a notification for an inventory MO, we will create a HCLStatusJob and inserted into the DB if it doesn't already exist. Then based on a timer we process the jobs in the DB and clear them. x-allOf-name: cond.HclStatusJob allOf: - # This 'cond.HclStatusJob' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'cond.HclStatusJob' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'cond.HclStatusJob', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'cond.HclStatusJob' ObjectType: enum: - 'cond.HclStatusJob' ManagedObject: # A Relationship to MO inventory.Base $ref: '#/components/schemas/inventory.Base.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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 config.ExportedItem.Response: description: |- The response body of a HTTP GET request for the 'config.ExportedItem' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'config.ExportedItem' resources. x-one-of-name: config.ExportedItem.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/config.ExportedItem.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType config.ExportedItem.Relationship: description: A relationship to the 'config.ExportedItem' resource, or the expanded 'config.ExportedItem' resource, or the 'null' value. x-one-of-name: config.ExportedItem.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/config.ExportedItem' config.ExportedItem: title: Config:Exported Item description: |- A single managed object that is being exported. x-allOf-name: config.ExportedItem allOf: - # This 'config.ExportedItem' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'config.ExportedItem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'config.ExportedItem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'config.ExportedItem' ObjectType: enum: - 'config.ExportedItem' FileName: description: |- Name of the file corresponding to item MO. type: string readOnly: true x-omitempty: true Item: description: |- Identity of the MO that is being exported. $ref: '#/components/schemas/config.MoRef' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 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. * `` - The operation has not started. * `InProgress` - The operation is in progress. * `Success` - The operation has succeeded. * `Failed` - The operation has failed. * `RollBackInitiated` - The rollback has been inititiated for import failure. * `RollBackFailed` - The rollback has failed for import failure. * `RollbackCompleted` - The rollback has completed for import failure. * `RollbackAborted` - The rollback has been aborted for import failure. * `OperationTimedOut` - The operation has timed out. type: string enum: - '' - 'InProgress' - 'Success' - 'Failed' - 'RollBackInitiated' - 'RollBackFailed' - 'RollbackCompleted' - 'RollbackAborted' - 'OperationTimedOut' 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 Exporter: # A Relationship to MO config.Exporter $ref: '#/components/schemas/config.Exporter.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a configExporter resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ParentItem: # A Relationship to MO config.ExportedItem $ref: '#/components/schemas/config.ExportedItem.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a configExportedItem resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RelatedItems: # A Relationship to MO config.ExportedItem description: An array of relationships to configExportedItem resources. type: array items: $ref: '#/components/schemas/config.ExportedItem.Relationship' nullable: true readOnly: true config.ExportedItem.List: title: List of 'config.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 'config.ExportedItem' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'config.ExportedItem' resources matching the request. type: array items: $ref: '#/components/schemas/config.ExportedItem' nullable: true config.Exporter.Response: description: |- The response body of a HTTP GET request for the 'config.Exporter' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'config.Exporter' resources. x-one-of-name: config.Exporter.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/config.Exporter.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType config.Exporter.Relationship: description: A relationship to the 'config.Exporter' resource, or the expanded 'config.Exporter' resource, or the 'null' value. x-one-of-name: config.Exporter.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/config.Exporter' config.Exporter: title: Config:Exporter description: |- All export operations are captured as Exporter instances. Users shall use this Exporter mo to track the export operation progress. x-allOf-name: config.Exporter allOf: - # This 'config.Exporter' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'config.Exporter' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'config.Exporter', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'config.Exporter' ObjectType: enum: - 'config.Exporter' DownloadPath: description: |- Pre-signed URL to download the exported package, if the export operation has completed successfully. Regenerated during a GET request, if the existing pre-signed URL has expired. type: string readOnly: true x-omitempty: true Items: type: array items: description: |- List of MOs to be exported. $ref: '#/components/schemas/config.MoRef' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-createOnly: true x-omitempty: true minItems: 1 Name: description: |- An identifier for the exporter instance. type: string x-createOnly: true x-omitempty: true Status: description: |- Status of the export operation. * `` - The operation has not started. * `InProgress` - The operation is in progress. * `Success` - The operation has succeeded. * `Failed` - The operation has failed. * `RollBackInitiated` - The rollback has been inititiated for import failure. * `RollBackFailed` - The rollback has failed for import failure. * `RollbackCompleted` - The rollback has completed for import failure. * `RollbackAborted` - The rollback has been aborted for import failure. * `OperationTimedOut` - The operation has timed out. type: string enum: - '' - 'InProgress' - 'Success' - 'Failed' - 'RollBackInitiated' - 'RollBackFailed' - 'RollbackCompleted' - 'RollbackAborted' - 'OperationTimedOut' default: "" readOnly: true x-omitempty: true StatusMessage: description: |- Status message associated with failures or progress indication. type: string readOnly: true x-omitempty: true ExportedItems: # A Relationship to MO config.ExportedItem description: An array of relationships to configExportedItem resources. type: array items: $ref: '#/components/schemas/config.ExportedItem.Relationship' nullable: true readOnly: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true config.Exporter.List: title: List of 'config.Exporter' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'config.Exporter' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'config.Exporter' resources matching the request. type: array items: $ref: '#/components/schemas/config.Exporter' nullable: true config.ImportedItem.Response: description: |- The response body of a HTTP GET request for the 'config.ImportedItem' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'config.ImportedItem' resources. x-one-of-name: config.ImportedItem.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/config.ImportedItem.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType config.ImportedItem.Relationship: description: A relationship to the 'config.ImportedItem' resource, or the expanded 'config.ImportedItem' resource, or the 'null' value. x-one-of-name: config.ImportedItem.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/config.ImportedItem' config.ImportedItem: title: Config:Imported Item description: |- A single managed object that is being imported. x-allOf-name: config.ImportedItem allOf: - # This 'config.ImportedItem' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'config.ImportedItem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'config.ImportedItem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'config.ImportedItem' ObjectType: enum: - 'config.ImportedItem' IsShared: description: |- Specifies whether this item MO was in shared scope or user scope when exported. type: boolean readOnly: true x-omitempty: true IsUpdated: description: |- Specifies whether this item MO was updated or created while importing in desired service. type: boolean readOnly: true x-omitempty: true Item: description: |- Identity of the MO that is being imported. $ref: '#/components/schemas/config.MoRef' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 NewMoid: description: |- Moid of the MO created/updated during import for the item. type: string readOnly: true x-omitempty: true ServiceVersion: description: |- Version of the service that owned the item MO when the item was exported. type: string readOnly: true x-omitempty: true Status: description: |- Status of the item's import operation. * `` - The operation has not started. * `InProgress` - The operation is in progress. * `Success` - The operation has succeeded. * `Failed` - The operation has failed. * `RollBackInitiated` - The rollback has been inititiated for import failure. * `RollBackFailed` - The rollback has failed for import failure. * `RollbackCompleted` - The rollback has completed for import failure. * `RollbackAborted` - The rollback has been aborted for import failure. * `OperationTimedOut` - The operation has timed out. type: string enum: - '' - 'InProgress' - 'Success' - 'Failed' - 'RollBackInitiated' - 'RollBackFailed' - 'RollbackCompleted' - 'RollbackAborted' - 'OperationTimedOut' default: "" readOnly: true x-omitempty: true StatusMessage: description: |- Progress or error message for the MO's import operation. type: string readOnly: true x-omitempty: true Importer: # A Relationship to MO config.Importer $ref: '#/components/schemas/config.Importer.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a configImporter resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true config.ImportedItem.List: title: List of 'config.ImportedItem' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'config.ImportedItem' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'config.ImportedItem' resources matching the request. type: array items: $ref: '#/components/schemas/config.ImportedItem' nullable: true config.Importer.Response: description: |- The response body of a HTTP GET request for the 'config.Importer' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'config.Importer' resources. x-one-of-name: config.Importer.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/config.Importer.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType config.Importer.Relationship: description: A relationship to the 'config.Importer' resource, or the expanded 'config.Importer' resource, or the 'null' value. x-one-of-name: config.Importer.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/config.Importer' config.Importer: title: Config:Importer description: |- All import operations are captured as Importer instances. Users shall use this Importer mo to track the import operation progress. x-allOf-name: config.Importer allOf: - # This 'config.Importer' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'config.Importer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'config.Importer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'config.Importer' ObjectType: enum: - 'config.Importer' ImportPath: description: |- The path to the archive in Intersight storage that has all the MOs to be imported. type: string x-createOnly: true x-omitempty: true ImportSource: description: |- The source of the archive in Intersight storage that has all the MOs to be imported. * `ImageRepo` - The 'ImageRepo' source if the source of exporter archive is image repository. * `URL` - The 'URL' source if the source of exported archive is a URL. type: string enum: - 'ImageRepo' - 'URL' default: ImageRepo x-createOnly: true x-omitempty: true Name: description: |- An identifier for the importer instance. type: string x-createOnly: true x-omitempty: true SkipIntegrityChecks: description: |- Specifies whether integrity checks must be skipped. type: boolean x-createOnly: true x-omitempty: true Status: description: |- Status of the import operation. * `` - The operation has not started. * `InProgress` - The operation is in progress. * `Success` - The operation has succeeded. * `Failed` - The operation has failed. * `RollBackInitiated` - The rollback has been inititiated for import failure. * `RollBackFailed` - The rollback has failed for import failure. * `RollbackCompleted` - The rollback has completed for import failure. * `RollbackAborted` - The rollback has been aborted for import failure. * `OperationTimedOut` - The operation has timed out. type: string enum: - '' - 'InProgress' - 'Success' - 'Failed' - 'RollBackInitiated' - 'RollBackFailed' - 'RollbackCompleted' - 'RollbackAborted' - 'OperationTimedOut' default: "" readOnly: true x-omitempty: true StatusMessage: description: |- Status message associated with failures or progress indication. type: string readOnly: true x-omitempty: true ImportedItems: # A Relationship to MO config.ImportedItem description: An array of relationships to configImportedItem resources. type: array items: $ref: '#/components/schemas/config.ImportedItem.Relationship' nullable: true readOnly: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true config.Importer.List: title: List of 'config.Importer' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'config.Importer' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'config.Importer' resources matching the request. type: array items: $ref: '#/components/schemas/config.Importer' nullable: true config.MoRef: title: Config:Mo Ref description: |- ConfigMoRef represents a reference to a managed object, uniquely identified by object type and MO ID. x-allOf-name: config.MoRef allOf: - # This 'config.MoRef' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'config.MoRef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'config.MoRef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'config.MoRef' ObjectType: enum: - 'config.MoRef' Moid: description: |- Moid represents the MoId of the object. type: string x-omitempty: true 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: - # This 'connector.AuthMessage' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'connector.AuthMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.AuthMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: RemoteUserLocale: description: |- The platform locale to assign user. A locale defines one or more organizations (domains) the user is allowed access, 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 platforms auditing. type: string x-omitempty: true connector.BaseMessage: title: Connector:Base Message description: |- A base abstract message that handles the common request properties applicable for all the message types. x-allOf-name: connector.BaseMessage allOf: - # This 'connector.BaseMessage' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'connector.BaseMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.BaseMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: 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 public key and passed as the value for this property. The 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. If the given public key is not same as device connector's public key, an error reponse 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 AES key must be mapped against the secure property name with a 'AES' prefix Device connector expects the message body to be a golang template and the template can use the secure property names as placeholders. # Property is any value, it may be the null value, an object or array. nullable: true 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: - # This 'connector.CloseStreamMessage' class inherits all properties from its parent class connector.StreamMessage. $ref: '#/components/schemas/connector.StreamMessage' connector.CommandControlMessage: title: Connector:Command Control Message description: |- A Command Message is sent from a cloud service to the connectors 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: - # This 'connector.CommandControlMessage' class inherits all properties from its parent class connector.AuthMessage. $ref: '#/components/schemas/connector.AuthMessage' - # The definition of all the properties specified in this 'connector.CommandControlMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.CommandControlMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.CommandControlMessage' ObjectType: enum: - 'connector.CommandControlMessage' Dir: description: |- The working directory of the command. If empty command is executed in the same directory 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 whitelisted by platform implementation, if a command does not match any whitelisted 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: - # This 'connector.CommandTerminalStream' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'connector.CommandTerminalStream' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.CommandTerminalStream', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.CommandTerminalStream' ObjectType: enum: - 'connector.CommandTerminalStream' 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: - # This 'connector.DownloadStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'connector.DownloadStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.DownloadStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Checksum: description: |- The checksum of the downloaded file as calculated by the download plugin after successfully downloading a file. $ref: '#/components/schemas/connector.FileChecksum' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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.ExpectPrompt: title: Expect Prompt description: |- This models a single expect and answer prompt of the interactive command. x-allOf-name: connector.ExpectPrompt allOf: - # This 'connector.ExpectPrompt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'connector.ExpectPrompt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.ExpectPrompt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.ExpectPrompt' ObjectType: enum: - 'connector.ExpectPrompt' 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 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: - # This 'connector.FetchStreamMessage' class inherits all properties from its parent class connector.StreamMessage. $ref: '#/components/schemas/connector.StreamMessage' - # The definition of all the properties specified in this 'connector.FetchStreamMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.FetchStreamMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.FetchStreamMessage' ObjectType: enum: - 'connector.FetchStreamMessage' Sequences: type: array items: description: |- List of sequences to retrieve from the stream cache. type: integer format: int64 x-omitempty: true connector.FileChecksum: title: Connector:File Checksum description: |- A checksum value of a files contents. Used to verify the integrity or equality of files on the file system. x-allOf-name: connector.FileChecksum allOf: - # This 'connector.FileChecksum' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'connector.FileChecksum' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.FileChecksum', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.FileChecksum' ObjectType: enum: - 'connector.FileChecksum' 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. * `crc` - A CRC hash as definded by RFC 3385. Generated with the IEEE polynomial. * `sha256` - A SHA256 hash as defined by RFC 4634. type: string enum: - 'crc' - 'sha256' default: crc x-omitempty: true connector.FileMessage: title: Connector:File Message description: |- Message carries file operations to perform on the platforms file system. Cloud services can send message to open and write to files on the connector platforms 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. If 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: - # This 'connector.FileMessage' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'connector.FileMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.FileMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.FileMessage' ObjectType: enum: - 'connector.FileMessage' MsgType: description: |- Message type carrying the file operation to perform. * `OpenFile` - Open a file for write to on the platforms 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 file does not exist file will be created, if it does exist file will be truncated. If the files parent directory does not exist an error will be returned. * `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 error and remove the opened file. * `CloseFile` - Close the file. Close message must be sent at the end of file transfer. If no close 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. * `DeleteFile` - Delete a file from the filesystem. If the file does not exist operation is a no-op and no error is returned. File must be within one of the platforms allowed writable directories. * `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. * `` - 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. * `GetFreeSpace` - Check 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' - '' - 'GetFreeSpace' default: OpenFile x-omitempty: true Path: description: |- The absolute path of the file to open on the platforms file system. Must be a sub-directory of a directory defined within the platform configurations 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. Only applicable for FileContent message. Ignored for OpenFile and CloseFile messages. type: string format: byte x-omitempty: true connector.HttpRequest: title: Connector:Http Request description: |- A HTTP request sent by a cloud service to be proxied through a device connector. x-allOf-name: connector.HttpRequest allOf: - # This 'connector.HttpRequest' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'connector.HttpRequest' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.HttpRequest', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.HttpRequest' ObjectType: enum: - 'connector.HttpRequest' Body: description: |- Contents of the request body to send for PUT/PATCH/POST requests. type: string format: byte 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 Header: description: |- Collection of key value pairs to set in the request header. # Property is any value, it may be the null value, an object or array. 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 five 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 allOf: - # This 'connector.PlatformParamBase' class inherits all properties from its parent class mo.BaseComplexType. $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: - # This 'connector.ScopedInventory' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'connector.ScopedInventory' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.ScopedInventory', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: NamingProperty: description: |- A property that uniquely identifies the object to be inventoried as a part of the scoped inventory. type: string 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 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: - # This 'connector.SshConfig' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'connector.SshConfig' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.SshConfig', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.SshConfig' ObjectType: enum: - 'connector.SshConfig' 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 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 connectors SSH plugin to open and execute operations on an SSH session. x-allOf-name: connector.SshMessage allOf: - # This 'connector.SshMessage' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'connector.SshMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.SshMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.SshMessage' ObjectType: enum: - 'connector.SshMessage' ExpectPrompts: type: array items: description: |- Array of prompts and answers necessary to execute an interactive ssh command. $ref: '#/components/schemas/connector.ExpectPrompt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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: - # This 'connector.StartStream' class inherits all properties from its parent class connector.StreamMessage. $ref: '#/components/schemas/connector.StreamMessage' - # The definition of all the properties specified in this 'connector.StartStream' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.StartStream', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.StartStream' ObjectType: enum: - 'connector.StartStream' BatchSize: description: |- The number of outputs from a plugin to collect into a single message. Applicable only to streams that involve polling plugins and plugins which support emitting batchable data. Default value of zero indicates no batching. type: integer format: int64 x-omitempty: true ForceRebuild: description: |- Flag to force a rebuild of an existing stream. To be used if a stream is unable to recover itself in response to dropped messages. type: boolean x-omitempty: true Input: description: |- Input to the plugin to start the start the stream or collect stream messages. type: string format: byte x-omitempty: true KeepAliveInterval: description: |- Interval at which device should emit a keepalive message for this stream. Device will also expect a keepalive response from the cloud within the interval. If zero, no keepalive is required and stream should not timeout. type: integer format: int64 x-omitempty: true PluginName: description: |- The plugin to run the stream on. type: string x-omitempty: true PollInterval: description: |- The desired interval to emit messages from this stream. The stream plugin will poll plugins at this interval to create a stream event. type: integer format: int64 x-omitempty: true Priority: description: |- The priority level to apply to messages emitted by this stream. type: integer format: int64 x-omitempty: true ProtocolVersion: description: |- The version of the device connector stream protocol. Used to change behavior of the device connector stream plugin based on the version of the Intersight service. Allows for multiple versions of Intersight services to interact with the stream plugin of devices. type: integer format: int64 x-omitempty: true ResponseTopic: description: |- The topic for the device connector to publish messages to. type: string x-omitempty: true 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: - # This 'connector.StartStreamFromDevice' class inherits all properties from its parent class connector.StreamMessage. $ref: '#/components/schemas/connector.StreamMessage' - # The definition of all the properties specified in this 'connector.StartStreamFromDevice' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.StartStreamFromDevice', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.StartStreamFromDevice' ObjectType: enum: - 'connector.StartStreamFromDevice' MemberId: description: |- The asset.ClusterMember member identity that is opening this stream. type: string x-omitempty: true MemberStream: description: |- The stream is to be started against the cluster member. type: boolean x-omitempty: true StreamConfig: description: |- Any extra configuration needed to open/identify a stream. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true StreamType: description: |- Identifies the type of stream to open to the device. The Intersight service will validate that the device should open a stream of this type and if so build a stream configuration and send it down to the device. The streamType should identify a unique stream to open to a device, that is if the device sends a stream open message and a stream of that type is already open in the cloud the existing stream should be re-used. type: string x-omitempty: true Topic: description: |- The topic the device should send the stream open message to. type: string x-omitempty: true 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: - # This 'connector.StreamAcknowledge' class inherits all properties from its parent class connector.StreamMessage. $ref: '#/components/schemas/connector.StreamMessage' - # The definition of all the properties specified in this 'connector.StreamAcknowledge' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.StreamAcknowledge', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.StreamAcknowledge' ObjectType: enum: - 'connector.StreamAcknowledge' AckSequence: description: |- The latest message sequence processed in the cloud. Device connector will drop all messages up to this sequence from its cache. type: integer format: int64 x-omitempty: true 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: - # This 'connector.StreamInput' class inherits all properties from its parent class connector.StreamMessage. $ref: '#/components/schemas/connector.StreamMessage' - # The definition of all the properties specified in this 'connector.StreamInput' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.StreamInput', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.StreamInput' ObjectType: enum: - 'connector.StreamInput' Input: description: |- The input to write to the stream plugin. type: string format: byte x-omitempty: true 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: - # This 'connector.StreamKeepalive' class inherits all properties from its parent class connector.StreamMessage. $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: - # This 'connector.StreamMessage' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'connector.StreamMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.StreamMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: StreamName: description: |- The requested stream name. Stream names are unique per device endpoint. type: string x-omitempty: true connector.Url: title: Connector:Url description: |- The URL to proxy the request to. x-allOf-name: connector.Url allOf: - # This 'connector.Url' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'connector.Url' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.Url', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.Url' ObjectType: enum: - 'connector.Url' 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. The 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.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: - # This 'connector.XmlApiMessage' class inherits all properties from its parent class connector.AuthMessage. $ref: '#/components/schemas/connector.AuthMessage' - # The definition of all the properties specified in this 'connector.XmlApiMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connector.XmlApiMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connector.XmlApiMessage' ObjectType: enum: - 'connector.XmlApiMessage' WithAuth: description: |- Flag to disable authentication bypassing. If set to true it is expected a valid cookie/login is 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 connectorpack.ConnectorPackUpdate: title: Connectorpack:Connector Pack Update x-allOf-name: connectorpack.ConnectorPackUpdate allOf: - # This 'connectorpack.ConnectorPackUpdate' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'connectorpack.ConnectorPackUpdate' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connectorpack.ConnectorPackUpdate', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connectorpack.ConnectorPackUpdate' ObjectType: enum: - 'connectorpack.ConnectorPackUpdate' CurrentVersion: description: |- Version of connector pack currently running in UCS Director. type: string readOnly: true x-omitempty: true Name: description: |- Name of the connector pack. type: string readOnly: true x-omitempty: true NewVersion: description: |- Version of connector pack to be installed in the next upgrade cycle. type: string readOnly: true x-omitempty: true connectorpack.ConnectorPackUpgrade.Response: description: |- The response body of a HTTP GET request for the 'connectorpack.ConnectorPackUpgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'connectorpack.ConnectorPackUpgrade' resources. x-one-of-name: connectorpack.ConnectorPackUpgrade.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/connectorpack.ConnectorPackUpgrade.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType connectorpack.ConnectorPackUpgrade: title: Connectorpack:Connector Pack Upgrade description: |- Used to download or install connector packs on the target device. x-allOf-name: connectorpack.ConnectorPackUpgrade allOf: - # This 'connectorpack.ConnectorPackUpgrade' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'connectorpack.ConnectorPackUpgrade' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connectorpack.ConnectorPackUpgrade', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connectorpack.ConnectorPackUpgrade' ObjectType: enum: - 'connectorpack.ConnectorPackUpgrade' ConnectorPackOpType: description: |- The type of operation to be performed on UCS Director. * `Install` - Installs the requisite connector packs on UCS Director. * `Push` - Pushes the requisite connector packs to UCS Director. type: string enum: - 'Install' - 'Push' default: Install x-omitempty: true UcsdInfo: # A Relationship to MO iaas.UcsdInfo $ref: '#/components/schemas/iaas.UcsdInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Workflow: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true connectorpack.ConnectorPackUpgrade.List: title: List of 'connectorpack.ConnectorPackUpgrade' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'connectorpack.ConnectorPackUpgrade' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'connectorpack.ConnectorPackUpgrade' resources matching the request. type: array items: $ref: '#/components/schemas/connectorpack.ConnectorPackUpgrade' nullable: true connectorpack.UpgradeImpact.Response: description: |- The response body of a HTTP GET request for the 'connectorpack.UpgradeImpact' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'connectorpack.UpgradeImpact' resources. x-one-of-name: connectorpack.UpgradeImpact.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/connectorpack.UpgradeImpact.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType connectorpack.UpgradeImpact: title: Connectorpack:Upgrade Impact description: |- Used to determine the list of connector packs to be installed on a target UCS Director in its next upgrade cycle. Accepts the moid of the target UcsdInfo as part of the filter query. Given below is a sample url :- https://{{target}}/api/v1/connectorpack/UpgradeImpacts?$filter=(UcsdInfo.Moid eq <>). x-allOf-name: connectorpack.UpgradeImpact allOf: - # This 'connectorpack.UpgradeImpact' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'connectorpack.UpgradeImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'connectorpack.UpgradeImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'connectorpack.UpgradeImpact' ObjectType: enum: - 'connectorpack.UpgradeImpact' ConnectorPack: type: array items: description: |- Information about connector pack updates available in the next upgrade cycle. $ref: '#/components/schemas/connectorpack.ConnectorPackUpdate' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true IsEligibleForUpgrade: description: |- States whether the UCS Director is eligible for an upgrade. Set to true if connector packs are available for upgrade, else set to false. type: boolean readOnly: true x-omitempty: true IsUpdateDownloaded: description: |- States whether all the requisite updates have been downloaded to the target UCS Director. Set to true if all connector packs required to upgrade UCS Director to the next iteration have been downloaded, else set to false. type: boolean readOnly: true x-omitempty: true UcsdInfo: # A Relationship to MO iaas.UcsdInfo $ref: '#/components/schemas/iaas.UcsdInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. connectorpack.UpgradeImpact.List: title: List of 'connectorpack.UpgradeImpact' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'connectorpack.UpgradeImpact' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'connectorpack.UpgradeImpact' resources matching the request. type: array items: $ref: '#/components/schemas/connectorpack.UpgradeImpact' nullable: true content.BaseParameter: title: BaseParameter description: |- A Baseparameter is an abstract definition of specific value to be extracted from a given API or device response. The BaseParameter object provides the name, type and content specific path, such as XPath or JSONPath, that points to the location of the parameter value in the content. Additional parameters necessary to extract data based on content type needs to extend BaseParameter. x-allOf-name: content.BaseParameter allOf: - # This 'content.BaseParameter' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'content.BaseParameter' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'content.BaseParameter', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AcceptSingleValue: description: |- The flag that allows single values in content to be extracted as a single element collection in case the parameter is of Collection type. This 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 parameter. The content.Grammar object must have a complex type, content.ComplexType, defined 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. * `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. * `complex` - The parameter value to be extracted is a complex parameter that itself isanother collection of simple/complex parameters. * `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' - '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 value within the content. The value is usually a XPath or JSONPath or a regular expression in case of text content. type: string x-omitempty: true Type: description: |- The type of the parameter. Accepted values are simple, complex, collection. * `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. * `complex` - The parameter value to be extracted is a complex parameter that itself isanother collection of simple/complex parameters. * `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' - '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 its properties can be modeled as a complex type. The types are uniquely named within the grammar and provides the list of parameters to be extracted from each item. Name of the complex type can be used as the type of parameter that represents the complex value. x-allOf-name: content.ComplexType allOf: - # This 'content.ComplexType' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'content.ComplexType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'content.ComplexType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'content.ComplexType' ObjectType: enum: - 'content.ComplexType' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true content.Grammar: title: Grammar Specification description: |- Content handler framework supports extraction of required values from API/device responses. These responses may be of various content types such as XML, JSON, etc. The values of importance are modeled as parameters in the content handler framework. The parameters can be of a scalar value type or a collection of values. A group of related parameters can be modeled as a single complex type parameter. These complex types will be very useful to extract a set of repeating group of related parameters. A grammar specification defines the set of parameters that need to be extracted from the content. The grammar specification allows complex type definitions to be defined for any complex parameters. x-allOf-name: content.Grammar allOf: - # This 'content.Grammar' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'content.Grammar' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'content.Grammar', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'content.Grammar' ObjectType: enum: - 'content.Grammar' ErrorParameters: type: array items: description: |- The list of parameter definitions, if found in a given API/device response, makes the content handlers to treat the response as error response. This is optional parameter. $ref: '#/components/schemas/content.BaseParameter' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Parameters: type: array items: description: |- The list of parameter definitions that mark the parameters to be extracted using this grammar specification. $ref: '#/components/schemas/content.BaseParameter' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Types: type: array items: description: |- The collection of complex types definitions used in this grammar specification. This is required only if any of the parameters provided in this grammar is of complex type. $ref: '#/components/schemas/content.ComplexType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true content.Parameter: title: Parameter description: |- Concrete implementation of BaseParameter for XML and JSON content types. x-allOf-name: content.Parameter allOf: - # This 'content.Parameter' class inherits all properties from its parent class content.BaseParameter. $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: - # This 'content.TextParameter' class inherits all properties from its parent class content.BaseParameter. $ref: '#/components/schemas/content.BaseParameter' - # The definition of all the properties specified in this 'content.TextParameter' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'content.TextParameter', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'content.TextParameter' ObjectType: enum: - 'content.TextParameter' IsDelimiter: description: |- Data to be extracted from text content can be simple type or complex type or collection of simple/complex types. Complex types are group of simple or complex type. Delimiter is required to stop parsing list and complex data types. isDelimiter specifies whether given TextParameter is a delimiter or regular rule to capture the text data. type: boolean x-omitempty: true IsNextCaptureOnSameLine: description: |- Set to true of the next value to capture resides on the same text line of current match. By default textFSM engine gets the next text line on finding the first match. type: boolean x-omitempty: true RegexLine: description: |- Regular expression of the line containing the data to be extracted from text content. type: string x-omitempty: true deviceconnector.Policy.Response: description: |- The response body of a HTTP GET request for the 'deviceconnector.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'deviceconnector.Policy' resources. x-one-of-name: deviceconnector.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/deviceconnector.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType deviceconnector.Policy: title: Device Connector description: |- Policy to control configuration changes allowed from Cisco IMC. x-allOf-name: deviceconnector.Policy allOf: - # This 'deviceconnector.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'deviceconnector.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'deviceconnector.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'deviceconnector.Policy' ObjectType: enum: - 'deviceconnector.Policy' LockoutEnabled: description: |- Enables configuration lockout on the endpoint. type: boolean x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true deviceconnector.Policy.List: title: List of 'deviceconnector.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'deviceconnector.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'deviceconnector.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/deviceconnector.Policy' nullable: true equipment.AbstractDevice: title: Equipment:Abstract Device description: |- Common attributes for inventory device in Intersight. x-allOf-name: equipment.AbstractDevice allOf: - # This 'equipment.AbstractDevice' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.AbstractDevice' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.AbstractDevice', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- Administrator defined name for the device. type: string readOnly: true x-omitempty: true Uuid: description: |- Unique identity of the device. type: string pattern: "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" readOnly: true x-omitempty: true Version: description: |- Current running software version of the device. type: string readOnly: true x-omitempty: true equipment.Base: title: Equipment:Base description: |- Abstract base class for all equipments which have a vendor /model / serial. x-allOf-name: equipment.Base allOf: - # This 'equipment.Base' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'equipment.Base' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Base', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Model: description: |- This field identifies the model of the given component. type: string readOnly: true x-omitempty: true Revision: description: |- This field identifies the revision of the given component. type: string readOnly: true x-omitempty: true Serial: description: |- This field identifies the serial of the given component. type: string readOnly: true x-omitempty: true Vendor: description: |- This field identifies the vendor of the given component. type: string readOnly: true x-omitempty: true equipment.Chassis.Response: description: |- The response body of a HTTP GET request for the 'equipment.Chassis' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.Chassis' resources. x-one-of-name: equipment.Chassis.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.Chassis.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.Chassis.Relationship: description: A relationship to the 'equipment.Chassis' resource, or the expanded 'equipment.Chassis' resource, or the 'null' value. x-one-of-name: equipment.Chassis.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.Chassis' equipment.Chassis: title: Equipment:Chassis description: |- A physical holder housing blade servers. x-allOf-name: equipment.Chassis allOf: - # This 'equipment.Chassis' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.Chassis' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Chassis', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.Chassis' ObjectType: enum: - 'equipment.Chassis' AlarmSummary: description: |- The summary of alarm counts based on the severity types (Critical or Warning). $ref: '#/components/schemas/compute.AlarmSummary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ChassisId: description: |- The assigned identifier for a chassis. type: integer format: int64 readOnly: true x-omitempty: true ConnectionPath: description: |- This field identifies the connectivity path for the chassis enclosure. type: string readOnly: true x-omitempty: true ConnectionStatus: description: |- This field identifies the connectivity status for the chassis enclosure. type: string readOnly: true x-omitempty: true Description: description: |- This field is to provide description for chassis model. type: string readOnly: true x-omitempty: true FaultSummary: description: |- This field summarizes the faults on the chassis enclosure. deprecated: true type: integer format: int64 x-omitempty: true ManagementMode: description: |- The management mode of the blade server chassis. * `IntersightStandalone` - Intersight Standalone mode of operation. * `UCSM` - Unified Computing System Manager mode of operation. * `Intersight` - Intersight managed mode of operation. type: string enum: - 'IntersightStandalone' - 'UCSM' - 'Intersight' default: IntersightStandalone readOnly: true x-omitempty: true Name: description: |- This field identifies the name for the chassis enclosure. type: string readOnly: true x-omitempty: true OperState: description: |- This field identifies the Chassis Operational State. type: string readOnly: true x-omitempty: true PartNumber: description: |- Part Number identifier for the chassis enclosure. type: string readOnly: true x-omitempty: true Pid: description: |- This field identifies the Product ID for the chassis enclosure. type: string readOnly: true x-omitempty: true PlatformType: description: |- The platform type that the chassis is a part of. type: string x-omitempty: true ProductName: description: |- This field identifies the Product Name for the chassis enclosure. type: string readOnly: true x-omitempty: true Sku: description: |- This field identifies the Stock Keeping Unit for the chassis enclosure. type: string readOnly: true x-omitempty: true Vid: description: |- This field identifies the Vendor ID for the chassis enclosure. type: string readOnly: true x-omitempty: true Blades: # A Relationship to MO compute.Blade description: An array of relationships to computeBlade resources. type: array items: $ref: '#/components/schemas/compute.Blade.Relationship' nullable: true readOnly: true Fanmodules: # A Relationship to MO equipment.FanModule description: An array of relationships to equipmentFanModule resources. type: array items: $ref: '#/components/schemas/equipment.FanModule.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Ioms: # A Relationship to MO equipment.IoCard description: An array of relationships to equipmentIoCard resources. type: array items: $ref: '#/components/schemas/equipment.IoCard.Relationship' nullable: true readOnly: true LocatorLed: # A Relationship to MO equipment.LocatorLed $ref: '#/components/schemas/equipment.LocatorLed.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentLocatorLed resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PsuControl: # A Relationship to MO equipment.PsuControl $ref: '#/components/schemas/equipment.PsuControl.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentPsuControl resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Psus: # A Relationship to MO equipment.Psu description: An array of relationships to equipmentPsu resources. type: array items: $ref: '#/components/schemas/equipment.Psu.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Sasexpanders: # A Relationship to MO storage.SasExpander description: An array of relationships to storageSasExpander resources. type: array items: $ref: '#/components/schemas/storage.SasExpander.Relationship' nullable: true readOnly: true Siocs: # A Relationship to MO equipment.SystemIoController description: An array of relationships to equipmentSystemIoController resources. type: array items: $ref: '#/components/schemas/equipment.SystemIoController.Relationship' nullable: true readOnly: true StorageEnclosures: # A Relationship to MO storage.Enclosure description: An array of relationships to storageEnclosure resources. type: array items: $ref: '#/components/schemas/storage.Enclosure.Relationship' nullable: true readOnly: true equipment.Chassis.List: title: List of 'equipment.Chassis' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.Chassis' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.Chassis' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.Chassis' nullable: true equipment.ChassisIdentity.Response: description: |- The response body of a HTTP GET request for the 'equipment.ChassisIdentity' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.ChassisIdentity' resources. x-one-of-name: equipment.ChassisIdentity.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.ChassisIdentity.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.ChassisIdentity: title: Chassis Identity description: |- ChassisIdentity Object conatains connectivity information about IOMs of the chassis. ChassisID is uniquely allocated for the combination of vendor, model and serial number of the chassis. x-allOf-name: equipment.ChassisIdentity allOf: - # This 'equipment.ChassisIdentity' class inherits all properties from its parent class equipment.Identity. $ref: '#/components/schemas/equipment.Identity' - # The definition of all the properties specified in this 'equipment.ChassisIdentity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.ChassisIdentity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.ChassisIdentity' ObjectType: enum: - 'equipment.ChassisIdentity' IoCardIdentityList: type: array items: description: |- List of IoCard Identity Connectivity Information. $ref: '#/components/schemas/equipment.IoCardIdentity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Chassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. equipment.ChassisIdentity.List: title: List of 'equipment.ChassisIdentity' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.ChassisIdentity' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.ChassisIdentity' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.ChassisIdentity' nullable: true equipment.DeviceSummary.Response: description: |- The response body of a HTTP GET request for the 'equipment.DeviceSummary' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.DeviceSummary' resources. x-one-of-name: equipment.DeviceSummary.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.DeviceSummary.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.DeviceSummary: title: Equipment:Device Summary description: |- Aggregation of properties pertaining to different inventory MOs. x-allOf-name: equipment.DeviceSummary allOf: - # This 'equipment.DeviceSummary' class inherits all properties from its parent class views.View. $ref: '#/components/schemas/views.View' - # The definition of all the properties specified in this 'equipment.DeviceSummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.DeviceSummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.DeviceSummary' ObjectType: enum: - 'equipment.DeviceSummary' Dn: description: |- The distinguished name for the Network Element. type: string readOnly: true x-omitempty: true Model: description: |- The model information of the Network Element. type: string readOnly: true x-omitempty: true Serial: description: |- The serial number for the Network Element. type: string readOnly: true x-omitempty: true SourceObjectType: description: |- The source object type of this view MO. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.DeviceSummary.List: title: List of 'equipment.DeviceSummary' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.DeviceSummary' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.DeviceSummary' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.DeviceSummary' nullable: true equipment.Fan.Response: description: |- The response body of a HTTP GET request for the 'equipment.Fan' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.Fan' resources. x-one-of-name: equipment.Fan.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.Fan.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.Fan.Relationship: description: A relationship to the 'equipment.Fan' resource, or the expanded 'equipment.Fan' resource, or the 'null' value. x-one-of-name: equipment.Fan.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.Fan' equipment.Fan: title: Equipment:Fan description: |- Fan in a Fabric Interconnect / Chassis / RackUnit. x-allOf-name: equipment.Fan allOf: - # This 'equipment.Fan' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.Fan' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Fan', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.Fan' ObjectType: enum: - 'equipment.Fan' Description: description: |- This field is to provide description for the fan. type: string readOnly: true x-omitempty: true FanId: description: |- This field acts as the identifier for this particular Fan, within the Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true FanModuleId: description: |- This field is used to identify the Fan Module to which this Fan belongs. type: integer format: int64 readOnly: true x-omitempty: true ModuleId: description: |- Fan module Identifier for the fan. type: integer format: int64 readOnly: true x-omitempty: true OperState: description: |- This field is used to indicate this fan unit's operational state. type: string readOnly: true x-omitempty: true PartNumber: description: |- This field identifies the Part Number for this Fan Unit. type: string readOnly: true x-omitempty: true Pid: description: |- This field identifies the Product ID for the fans. type: string readOnly: true x-omitempty: true Presence: description: |- This field is used to indicate this fan unit's presence. type: string readOnly: true x-omitempty: true Sku: description: |- This field identifies the Stockkeeping Unit for this Fan Unit. type: string readOnly: true x-omitempty: true TrayId: description: |- Tray identifier for the fan module. type: integer format: int64 readOnly: true x-omitempty: true Vid: description: |- This field identifies the Vendor ID for this Fan Unit. type: string readOnly: true x-omitempty: true EquipmentFanModule: # A Relationship to MO equipment.FanModule $ref: '#/components/schemas/equipment.FanModule.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentFanModule resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentFex: # A Relationship to MO equipment.Fex $ref: '#/components/schemas/equipment.Fex.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentFex resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.Fan.List: title: List of 'equipment.Fan' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.Fan' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.Fan' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.Fan' nullable: true equipment.FanModule.Response: description: |- The response body of a HTTP GET request for the 'equipment.FanModule' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.FanModule' resources. x-one-of-name: equipment.FanModule.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.FanModule.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.FanModule.Relationship: description: A relationship to the 'equipment.FanModule' resource, or the expanded 'equipment.FanModule' resource, or the 'null' value. x-one-of-name: equipment.FanModule.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.FanModule' equipment.FanModule: title: Equipment:Fan Module description: |- This represents Fan module housing multiple fans for chassis/server. x-allOf-name: equipment.FanModule allOf: - # This 'equipment.FanModule' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.FanModule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.FanModule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.FanModule' ObjectType: enum: - 'equipment.FanModule' Description: description: |- This field is to provide description for the fan module. type: string readOnly: true x-omitempty: true ModuleId: description: |- This field acts as the identifier for this particular Module, within the Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true OperState: description: |- This field is used to indicate this fan module's operational state. type: string readOnly: true x-omitempty: true PartNumber: description: |- This field identifies the Part Number for this Fan Module. type: string readOnly: true x-omitempty: true Pid: description: |- This field identifies the Product ID for the fan module. type: string readOnly: true x-omitempty: true Presence: description: |- This field is used to indicate this fan module's presence. type: string readOnly: true x-omitempty: true Sku: description: |- This field identifies the Stockkeeping Unit for this Fan Module. type: string readOnly: true x-omitempty: true TrayId: description: |- Tray identifier for the fan module. type: integer format: int64 readOnly: true x-omitempty: true Vid: description: |- This field identifies the Vendor ID for this Fan Module. type: string readOnly: true x-omitempty: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentRackEnclosure: # A Relationship to MO equipment.RackEnclosure $ref: '#/components/schemas/equipment.RackEnclosure.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentRackEnclosure resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Fans: # A Relationship to MO equipment.Fan description: An array of relationships to equipmentFan resources. type: array items: $ref: '#/components/schemas/equipment.Fan.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.FanModule.List: title: List of 'equipment.FanModule' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.FanModule' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.FanModule' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.FanModule' nullable: true equipment.Fex.Response: description: |- The response body of a HTTP GET request for the 'equipment.Fex' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.Fex' resources. x-one-of-name: equipment.Fex.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.Fex.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.Fex.Relationship: description: A relationship to the 'equipment.Fex' resource, or the expanded 'equipment.Fex' resource, or the 'null' value. x-one-of-name: equipment.Fex.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.Fex' equipment.Fex: title: Equipment:Fex description: |- Fabric Extender which can mutiplex traffic from the host facing ports. x-allOf-name: equipment.Fex allOf: - # This 'equipment.Fex' class inherits all properties from its parent class equipment.IoCardBase. $ref: '#/components/schemas/equipment.IoCardBase' - # The definition of all the properties specified in this 'equipment.Fex' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Fex', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.Fex' ObjectType: enum: - 'equipment.Fex' DiscoveryState: description: |- Discovery state of IO card or fabric extender. type: string x-omitempty: true Fans: # A Relationship to MO equipment.Fan description: An array of relationships to equipmentFan resources. type: array items: $ref: '#/components/schemas/equipment.Fan.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true LocatorLed: # A Relationship to MO equipment.LocatorLed $ref: '#/components/schemas/equipment.LocatorLed.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentLocatorLed resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. Psus: # A Relationship to MO equipment.Psu description: An array of relationships to equipmentPsu resources. type: array items: $ref: '#/components/schemas/equipment.Psu.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.Fex.List: title: List of 'equipment.Fex' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.Fex' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.Fex' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.Fex' nullable: true equipment.FexIdentity.Response: description: |- The response body of a HTTP GET request for the 'equipment.FexIdentity' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.FexIdentity' resources. x-one-of-name: equipment.FexIdentity.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.FexIdentity.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.FexIdentity: title: Equipment:Fex Identity description: |- FexIdentity Object conatains basic information of fabric extender. moduleId is uniquely allocated for the combination of vendor, model and serial number of the chassis. x-allOf-name: equipment.FexIdentity allOf: - # This 'equipment.FexIdentity' class inherits all properties from its parent class equipment.PhysicalIdentity. $ref: '#/components/schemas/equipment.PhysicalIdentity' - # The definition of all the properties specified in this 'equipment.FexIdentity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.FexIdentity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.FexIdentity' ObjectType: enum: - 'equipment.FexIdentity' SwitchId: description: |- Switch ID to which Fabric Extender is connected, ID can be either 1 or 2, equalent to A or B. type: integer format: int64 x-omitempty: true Fex: # A Relationship to MO equipment.Fex $ref: '#/components/schemas/equipment.Fex.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentFex resource. When the $expand query parameter is specified, the referenced resource is returned inline. NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. equipment.FexIdentity.List: title: List of 'equipment.FexIdentity' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.FexIdentity' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.FexIdentity' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.FexIdentity' nullable: true equipment.FexOperation.Response: description: |- The response body of a HTTP GET request for the 'equipment.FexOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.FexOperation' resources. x-one-of-name: equipment.FexOperation.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.FexOperation.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.FexOperation: title: Fabric Extender operations description: |- Models the configuration states of a FEX in Intersight. x-allOf-name: equipment.FexOperation allOf: - # This 'equipment.FexOperation' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'equipment.FexOperation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.FexOperation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.FexOperation' ObjectType: enum: - 'equipment.FexOperation' AdminLocatorLedAction: description: |- Action performed on the locator LED for a FEX. * `None` - No operation action for the Locator Led of an equipment. * `TurnOn` - Turn on the Locator Led of an equipment. * `TurnOff` - Turn off the Locator Led of an equipment. type: string enum: - 'None' - 'TurnOn' - 'TurnOff' default: None x-omitempty: true AdminLocatorLedActionState: description: |- Defines status of action performed on AdminLocatorLedState. * `None` - Nil value when no action has been triggered by the user. * `Applied` - User configured settings are in applied state. * `Applying` - User settings are being applied on the target server. * `Failed` - User configured settings could not be applied. type: string enum: - 'None' - 'Applied' - 'Applying' - 'Failed' default: None x-omitempty: true DeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Fex: # A Relationship to MO equipment.Fex $ref: '#/components/schemas/equipment.Fex.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentFex resource. When the $expand query parameter is specified, the referenced resource is returned inline. equipment.FexOperation.List: title: List of 'equipment.FexOperation' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.FexOperation' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.FexOperation' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.FexOperation' nullable: true equipment.Identity: title: Equipment:Identity description: |- An Abstract Identity object that uniquely represents an equipment. x-allOf-name: equipment.Identity allOf: - # This 'equipment.Identity' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'equipment.Identity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Identity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AdminAction: description: |- Updated by UI/API to trigger specific chassis action type. * `None` - No operation value for maintenance actions on an equipment. * `Decommission` - Decommission the equipment and temporarily remove it from being managed by Intersight. * `Recommission` - Recommission the equipment. * `Reack` - Reacknowledge the equipment and discover it again. * `Remove` - Remove the equipment permanently from Intersight management. type: string enum: - 'None' - 'Decommission' - 'Recommission' - 'Reack' - 'Remove' default: None x-omitempty: true AdminActionState: description: |- The state of Maintenance Action performed. This will have three states. Applying - Action is in progress. Applied - Action is completed and applied. Failed - Action has failed. * `None` - Nil value when no action has been triggered by the user. * `Applied` - User configured settings are in applied state. * `Applying` - User settings are being applied on the target server. * `Failed` - User configured settings could not be applied. type: string enum: - 'None' - 'Applied' - 'Applying' - 'Failed' default: None x-omitempty: true Identifier: description: |- Numeric Identifier assigned by the management system to the equipment. type: integer format: int64 x-omitempty: true Lifecycle: description: |- The equipment's lifecycle status. * `None` - Default state of an equipment. This should be an initial state when no state is defined for an equipment. * `Active` - Default Lifecycle State for a physical entity. * `Decommissioned` - Decommission Lifecycle state. * `DecommissionInProgress` - Decommission Inprogress Lifecycle state. * `RecommissionInProgress` - Recommission Inprogress Lifecycle state. * `OperationFailed` - Failed Operation Lifecycle state. * `ReackInProgress` - ReackInProgress Lifecycle state. * `RemoveInProgress` - RemoveInProgress Lifecycle state. * `Discovered` - Discovered Lifecycle state. * `DiscoveryInProgress` - DiscoveryInProgress Lifecycle state. * `DiscoveryFailed` - DiscoveryFailed Lifecycle state. type: string enum: - 'None' - 'Active' - 'Decommissioned' - 'DecommissionInProgress' - 'RecommissionInProgress' - 'OperationFailed' - 'ReackInProgress' - 'RemoveInProgress' - 'Discovered' - 'DiscoveryInProgress' - 'DiscoveryFailed' default: None x-omitempty: true Model: description: |- The vendor provided model name for the equipment. type: string x-omitempty: true Serial: description: |- The serial number of the equipment. type: string x-omitempty: true Vendor: description: |- The manufacturer of the equipment. type: string x-omitempty: true DeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. equipment.IdentitySummary.Response: description: |- The response body of a HTTP GET request for the 'equipment.IdentitySummary' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.IdentitySummary' resources. x-one-of-name: equipment.IdentitySummary.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.IdentitySummary.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.IdentitySummary: title: Equipment:Identity Summary description: |- Consolidated view of all equipment identities. x-allOf-name: equipment.IdentitySummary allOf: - # This 'equipment.IdentitySummary' class inherits all properties from its parent class views.View. $ref: '#/components/schemas/views.View' - # The definition of all the properties specified in this 'equipment.IdentitySummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.IdentitySummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.IdentitySummary' ObjectType: enum: - 'equipment.IdentitySummary' AdapterSerial: description: |- Serial Identifier of an adapter participating in SWM. type: string readOnly: true x-omitempty: true AdminAction: description: |- Updated by UI/API to trigger specific chassis action type. * `None` - No operation value for maintenance actions on an equipment. * `Decommission` - Decommission the equipment and temporarily remove it from being managed by Intersight. * `Recommission` - Recommission the equipment. * `Reack` - Reacknowledge the equipment and discover it again. * `Remove` - Remove the equipment permanently from Intersight management. type: string enum: - 'None' - 'Decommission' - 'Recommission' - 'Reack' - 'Remove' default: None readOnly: true x-omitempty: true AdminActionState: description: |- The state of Maintenance Action performed. This will have three states. Applying - Action is in progress. Applied - Action is completed and applied. Failed - Action has failed. * `None` - Nil value when no action has been triggered by the user. * `Applied` - User configured settings are in applied state. * `Applying` - User settings are being applied on the target server. * `Failed` - User configured settings could not be applied. type: string enum: - 'None' - 'Applied' - 'Applying' - 'Failed' default: None readOnly: true x-omitempty: true ChassisId: description: |- Chassis Identifier of a blade server. type: integer format: int64 readOnly: true x-omitempty: true DeviceMoId: description: |- FI Device registration Mo ID. type: string readOnly: true x-omitempty: true Identifier: description: |- Numeric Identifier assigned by the management system to the equipment. type: integer format: int64 readOnly: true x-omitempty: true IoCardIdentityList: type: array items: description: |- List of IoCard Identity Connectivity Information. $ref: '#/components/schemas/equipment.IoCardIdentity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Lifecycle: description: |- The equipment's lifecycle status. * `None` - Default state of an equipment. This should be an initial state when no state is defined for an equipment. * `Active` - Default Lifecycle State for a physical entity. * `Decommissioned` - Decommission Lifecycle state. * `DecommissionInProgress` - Decommission Inprogress Lifecycle state. * `RecommissionInProgress` - Recommission Inprogress Lifecycle state. * `OperationFailed` - Failed Operation Lifecycle state. * `ReackInProgress` - ReackInProgress Lifecycle state. * `RemoveInProgress` - RemoveInProgress Lifecycle state. * `Discovered` - Discovered Lifecycle state. * `DiscoveryInProgress` - DiscoveryInProgress Lifecycle state. * `DiscoveryFailed` - DiscoveryFailed Lifecycle state. type: string enum: - 'None' - 'Active' - 'Decommissioned' - 'DecommissionInProgress' - 'RecommissionInProgress' - 'OperationFailed' - 'ReackInProgress' - 'RemoveInProgress' - 'Discovered' - 'DiscoveryInProgress' - 'DiscoveryFailed' default: None readOnly: true x-omitempty: true Model: description: |- The vendor provided model name for the equipment. type: string readOnly: true x-omitempty: true PendingDiscovery: description: |- Indicates pending discovery flag. type: string readOnly: true x-omitempty: true Serial: description: |- The serial number of the equipment. type: string readOnly: true x-omitempty: true SlotId: description: |- Chassis slot number of a blade server. type: integer format: int64 readOnly: true x-omitempty: true SourceObjectType: description: |- The source object type of this view MO. type: string readOnly: true x-omitempty: true SwitchId: description: |- Switch ID to which Fabric Extender is connected, ID can be either 1 or 2, equalent to A or B. type: integer format: int64 readOnly: true x-omitempty: true Vendor: description: |- The manufacturer of the equipment. type: string readOnly: true x-omitempty: true DeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.IdentitySummary.List: title: List of 'equipment.IdentitySummary' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.IdentitySummary' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.IdentitySummary' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.IdentitySummary' nullable: true equipment.IoCard.Response: description: |- The response body of a HTTP GET request for the 'equipment.IoCard' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.IoCard' resources. x-one-of-name: equipment.IoCard.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.IoCard.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.IoCard.Relationship: description: A relationship to the 'equipment.IoCard' resource, or the expanded 'equipment.IoCard' resource, or the 'null' value. x-one-of-name: equipment.IoCard.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.IoCard' equipment.IoCard: title: Equipment:Io Card description: |- I/O module on a chassis which multiplexes traffic from blade servers. x-allOf-name: equipment.IoCard allOf: - # This 'equipment.IoCard' class inherits all properties from its parent class equipment.IoCardBase. $ref: '#/components/schemas/equipment.IoCardBase' - # The definition of all the properties specified in this 'equipment.IoCard' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.IoCard', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.IoCard' ObjectType: enum: - 'equipment.IoCard' ConnectionPath: description: |- Switch Id to which the IOM is connected to. The value can be A or B. type: string readOnly: true x-omitempty: true DcSupported: description: |- IOM device connector support. type: boolean readOnly: true x-omitempty: true Side: description: |- Location of IOM within a chassis. The value can be left or right. type: string readOnly: true x-omitempty: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalDeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.IoCard.List: title: List of 'equipment.IoCard' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.IoCard' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.IoCard' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.IoCard' nullable: true equipment.IoCardBase.Relationship: description: A relationship to the 'equipment.IoCardBase' resource, or the expanded 'equipment.IoCardBase' resource, or the 'null' value. x-one-of-name: equipment.IoCardBase.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.IoCardBase' equipment.IoCardBase: title: Equipment:Io Card Base description: |- Abstract class for hif and nif ports collection that can be extended by chassis/febric extender. x-allOf-name: equipment.IoCardBase allOf: - # This 'equipment.IoCardBase' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.IoCardBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.IoCardBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ConnectionStatus: description: |- Connectivity Status of FEX/IOM to Switch - A or B or AB. type: string x-omitempty: true Description: description: |- This field is to provide description for the iocard module model. type: string readOnly: true x-omitempty: true ModuleId: description: |- Module Identifier for the IO module. type: integer format: int64 readOnly: true x-omitempty: true OperState: description: |- Operational state of IO card or fabric extender. type: string readOnly: true x-omitempty: true PartNumber: description: |- Part Number identifier for the IO module. type: string readOnly: true x-omitempty: true Pid: description: |- This field identifies the Product ID for the IO module. type: string readOnly: true x-omitempty: true Presence: description: |- This field identifies the Presence state of the IO card module. type: string readOnly: true x-omitempty: true ProductName: description: |- This field identifies the Product Name for the iocard module model. type: string readOnly: true x-omitempty: true Sku: description: |- This field identifies the Stock Keeping Unit for the IO card module. type: string readOnly: true x-omitempty: true Version: description: |- This field identifies the version of the IO card module. type: string readOnly: true x-omitempty: true Vid: description: |- This field identifies the Vendor ID for the IO card module. type: string readOnly: true x-omitempty: true HostPorts: # A Relationship to MO ether.HostPort description: An array of relationships to etherHostPort resources. type: array items: $ref: '#/components/schemas/ether.HostPort.Relationship' nullable: true MgmtController: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. NetworkPorts: # A Relationship to MO ether.NetworkPort description: An array of relationships to etherNetworkPort resources. type: array items: $ref: '#/components/schemas/ether.NetworkPort.Relationship' nullable: true equipment.IoCardIdentity: title: Equipment:Io Card Identity description: |- IoCardIdentity Complex type referenced in ChassisIdentity concrete MO. x-allOf-name: equipment.IoCardIdentity allOf: - # This 'equipment.IoCardIdentity' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'equipment.IoCardIdentity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.IoCardIdentity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.IoCardIdentity' ObjectType: enum: - 'equipment.IoCardIdentity' IoCardMoid: description: |- MO Reference to equipmentIoCard MO in inventory service. type: string x-omitempty: true ModuleId: description: |- IOM/MUX Module ID connected to the FI. type: integer format: int64 x-omitempty: true NetworkElementMoid: description: |- MO Reference to networkElement MO in inventory service. type: string x-omitempty: true SwitchId: description: |- Switch ID to which IOM is connected, ID can be either 1 or 2, equalent to A or B. type: integer format: int64 x-omitempty: true equipment.IoCardOperation.Response: description: |- The response body of a HTTP GET request for the 'equipment.IoCardOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.IoCardOperation' resources. x-one-of-name: equipment.IoCardOperation.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.IoCardOperation.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.IoCardOperation: title: IO Module Operations description: |- Models the configurable properties of a iomodule in Intersight. x-allOf-name: equipment.IoCardOperation allOf: - # This 'equipment.IoCardOperation' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'equipment.IoCardOperation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.IoCardOperation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.IoCardOperation' ObjectType: enum: - 'equipment.IoCardOperation' AdminPowerState: description: |- User configured power state of the iomodule. * `None` - Placeholder default value for iom power state property. * `Reboot` - IO Module reboot state property value. type: string enum: - 'None' - 'Reboot' default: None x-omitempty: true ConfigState: description: |- The configured state of these settings in the target chassis. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target chassis iomodule. Applying - This state denotes that the settings are being applied in the target chassis iomodule. Failed - This state denotes that the settings could not be applied in the target chassis iomodule. * `None` - Nil value when no action has been triggered by the user. * `Applied` - User configured settings are in applied state. * `Applying` - User settings are being applied on the target server. * `Failed` - User configured settings could not be applied. type: string enum: - 'None' - 'Applied' - 'Applying' - 'Failed' default: None readOnly: true x-omitempty: true DeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true IoCard: # A Relationship to MO equipment.IoCard $ref: '#/components/schemas/equipment.IoCard.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentIoCard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.IoCardOperation.List: title: List of 'equipment.IoCardOperation' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.IoCardOperation' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.IoCardOperation' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.IoCardOperation' nullable: true equipment.IoExpander.Response: description: |- The response body of a HTTP GET request for the 'equipment.IoExpander' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.IoExpander' resources. x-one-of-name: equipment.IoExpander.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.IoExpander.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.IoExpander.Relationship: description: A relationship to the 'equipment.IoExpander' resource, or the expanded 'equipment.IoExpander' resource, or the 'null' value. x-one-of-name: equipment.IoExpander.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.IoExpander' equipment.IoExpander: title: Equipment:Io Expander description: |- I/O expander card which is used as an extension for servers in a Colusa Chassis. x-allOf-name: equipment.IoExpander allOf: - # This 'equipment.IoExpander' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.IoExpander' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.IoExpander', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.IoExpander' ObjectType: enum: - 'equipment.IoExpander' OperState: description: |- Identifies the operational state of I/O expander. type: string readOnly: true x-omitempty: true Presence: description: |- Identifies the availability of I/O expander. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.IoExpander.List: title: List of 'equipment.IoExpander' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.IoExpander' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.IoExpander' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.IoExpander' nullable: true equipment.LocatorLed.Response: description: |- The response body of a HTTP GET request for the 'equipment.LocatorLed' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.LocatorLed' resources. x-one-of-name: equipment.LocatorLed.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.LocatorLed.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.LocatorLed.Relationship: description: A relationship to the 'equipment.LocatorLed' resource, or the expanded 'equipment.LocatorLed' resource, or the 'null' value. x-one-of-name: equipment.LocatorLed.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.LocatorLed' equipment.LocatorLed: title: Equipment:Locator Led description: |- Locator Led of an Equipment like Rack, Disk etc. x-allOf-name: equipment.LocatorLed allOf: - # This 'equipment.LocatorLed' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'equipment.LocatorLed' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.LocatorLed', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.LocatorLed' ObjectType: enum: - 'equipment.LocatorLed' Color: description: |- Color of the locatorled available on an equipment. type: string readOnly: true x-omitempty: true OperState: description: |- Identifies the operational state of locatorled. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentFex: # A Relationship to MO equipment.Fex $ref: '#/components/schemas/equipment.Fex.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentFex resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StoragePhysicalDisk: # A Relationship to MO storage.PhysicalDisk $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePhysicalDisk resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.LocatorLed.List: title: List of 'equipment.LocatorLed' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.LocatorLed' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.LocatorLed' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.LocatorLed' nullable: true equipment.PhysicalIdentity.Relationship: description: A relationship to the 'equipment.PhysicalIdentity' resource, or the expanded 'equipment.PhysicalIdentity' resource, or the 'null' value. x-one-of-name: equipment.PhysicalIdentity.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.PhysicalIdentity' equipment.PhysicalIdentity: title: Equipment:Physical Identity description: |- An Abstract Identity object that uniquely represents a server object under a DR. x-allOf-name: equipment.PhysicalIdentity allOf: - # This 'equipment.PhysicalIdentity' class inherits all properties from its parent class equipment.Identity. $ref: '#/components/schemas/equipment.Identity' - # The definition of all the properties specified in this 'equipment.PhysicalIdentity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.PhysicalIdentity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: PhysicalDeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. equipment.Psu.Response: description: |- The response body of a HTTP GET request for the 'equipment.Psu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.Psu' resources. x-one-of-name: equipment.Psu.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.Psu.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.Psu.Relationship: description: A relationship to the 'equipment.Psu' resource, or the expanded 'equipment.Psu' resource, or the 'null' value. x-one-of-name: equipment.Psu.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.Psu' equipment.Psu: title: Equipment:Psu description: |- This represents power supply unit for chassis/server. x-allOf-name: equipment.Psu allOf: - # This 'equipment.Psu' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.Psu' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Psu', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.Psu' ObjectType: enum: - 'equipment.Psu' Description: description: |- This field is to provide description for the power supply unit. type: string readOnly: true x-omitempty: true OperState: description: |- This field identifies the psu operational state. type: string readOnly: true x-omitempty: true PartNumber: description: |- This field identifies the Part Number for this Power Supply Unit. type: string readOnly: true x-omitempty: true Pid: description: |- This field identifies the Product ID for the Power Supply. type: string readOnly: true x-omitempty: true Presence: description: |- This field identifies the presence state of the psu. type: string readOnly: true x-omitempty: true PsuFwVersion: description: |- This field identifies the Firmware Version of the Power Supply. type: string readOnly: true x-omitempty: true PsuId: description: |- This represents power supply unit identifier in chassis/server. type: integer format: int64 readOnly: true x-omitempty: true PsuInputSrc: description: |- This field identifies the input source for the Power Supply. type: string readOnly: true x-omitempty: true PsuType: description: |- This field identifies the type of the Power Supply. type: string readOnly: true x-omitempty: true PsuWattage: description: |- This field identifies the Wattage of the Power Supply. type: string readOnly: true x-omitempty: true Sku: description: |- This field identifies the Stockkeeping Unit for this Power Supply. type: string readOnly: true x-omitempty: true Vid: description: |- This field identifies the Vendor ID for this Power Supply Unit. type: string readOnly: true x-omitempty: true Voltage: description: |- This field is used to indicate the Voltage for this Power Supply. type: string readOnly: true x-omitempty: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentFex: # A Relationship to MO equipment.Fex $ref: '#/components/schemas/equipment.Fex.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentFex resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentRackEnclosure: # A Relationship to MO equipment.RackEnclosure $ref: '#/components/schemas/equipment.RackEnclosure.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentRackEnclosure resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.Psu.List: title: List of 'equipment.Psu' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.Psu' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.Psu' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.Psu' nullable: true equipment.PsuControl.Response: description: |- The response body of a HTTP GET request for the 'equipment.PsuControl' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.PsuControl' resources. x-one-of-name: equipment.PsuControl.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.PsuControl.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.PsuControl.Relationship: description: A relationship to the 'equipment.PsuControl' resource, or the expanded 'equipment.PsuControl' resource, or the 'null' value. x-one-of-name: equipment.PsuControl.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.PsuControl' equipment.PsuControl: title: Equipment:Psu Control description: |- This represents the power states of an equipment. x-allOf-name: equipment.PsuControl allOf: - # This 'equipment.PsuControl' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.PsuControl' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.PsuControl', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.PsuControl' ObjectType: enum: - 'equipment.PsuControl' ClusterState: description: |- This field identifies the cluster state of the psu redundancy. type: string readOnly: true x-omitempty: true InputPowerState: description: |- This field identifies the input power state of the psus. type: string readOnly: true x-omitempty: true Name: description: |- This field identifies the name of psu control object. type: string readOnly: true x-omitempty: true OperQualifier: description: |- This field identifies the operational qualifier for the psu redundancy. type: string readOnly: true x-omitempty: true OperState: description: |- This field identifies the operational state of the psu redundancy. type: string readOnly: true x-omitempty: true OutputPowerState: description: |- This field identifies the output power state of the psus. type: string readOnly: true x-omitempty: true Redundancy: description: |- This field identifies the redundancy state of the psus. type: string readOnly: true x-omitempty: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.PsuControl.List: title: List of 'equipment.PsuControl' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.PsuControl' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.PsuControl' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.PsuControl' nullable: true equipment.RackEnclosure.Response: description: |- The response body of a HTTP GET request for the 'equipment.RackEnclosure' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.RackEnclosure' resources. x-one-of-name: equipment.RackEnclosure.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.RackEnclosure.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.RackEnclosure.Relationship: description: A relationship to the 'equipment.RackEnclosure' resource, or the expanded 'equipment.RackEnclosure' resource, or the 'null' value. x-one-of-name: equipment.RackEnclosure.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.RackEnclosure' equipment.RackEnclosure: title: Equipment:Rack Enclosure description: |- A physical holder housing rack servers. x-allOf-name: equipment.RackEnclosure allOf: - # This 'equipment.RackEnclosure' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.RackEnclosure' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.RackEnclosure', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.RackEnclosure' ObjectType: enum: - 'equipment.RackEnclosure' EnclosureId: description: |- This represents the Enclosure Identifier for Rack servers. type: integer format: int64 readOnly: true x-omitempty: true Fanmodules: # A Relationship to MO equipment.FanModule description: An array of relationships to equipmentFanModule resources. type: array items: $ref: '#/components/schemas/equipment.FanModule.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Psus: # A Relationship to MO equipment.Psu description: An array of relationships to equipmentPsu resources. type: array items: $ref: '#/components/schemas/equipment.Psu.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Slots: # A Relationship to MO equipment.RackEnclosureSlot description: An array of relationships to equipmentRackEnclosureSlot resources. type: array items: $ref: '#/components/schemas/equipment.RackEnclosureSlot.Relationship' nullable: true readOnly: true equipment.RackEnclosure.List: title: List of 'equipment.RackEnclosure' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.RackEnclosure' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.RackEnclosure' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.RackEnclosure' nullable: true equipment.RackEnclosureSlot.Response: description: |- The response body of a HTTP GET request for the 'equipment.RackEnclosureSlot' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.RackEnclosureSlot' resources. x-one-of-name: equipment.RackEnclosureSlot.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.RackEnclosureSlot.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.RackEnclosureSlot.Relationship: description: A relationship to the 'equipment.RackEnclosureSlot' resource, or the expanded 'equipment.RackEnclosureSlot' resource, or the 'null' value. x-one-of-name: equipment.RackEnclosureSlot.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.RackEnclosureSlot' equipment.RackEnclosureSlot: title: Equipment:Rack Enclosure Slot description: |- Rack Server Slot in a RackEnclosure. x-allOf-name: equipment.RackEnclosureSlot allOf: - # This 'equipment.RackEnclosureSlot' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.RackEnclosureSlot' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.RackEnclosureSlot', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.RackEnclosureSlot' ObjectType: enum: - 'equipment.RackEnclosureSlot' RackId: description: |- Server ID which is part of Rack Enclosure Slot. type: integer format: int64 readOnly: true x-omitempty: true RackUnitDn: description: |- Server DN which is part of Rack Enclosure Slot. type: string readOnly: true x-omitempty: true EquipmentRackEnclosure: # A Relationship to MO equipment.RackEnclosure $ref: '#/components/schemas/equipment.RackEnclosure.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentRackEnclosure resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.RackEnclosureSlot.List: title: List of 'equipment.RackEnclosureSlot' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.RackEnclosureSlot' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.RackEnclosureSlot' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.RackEnclosureSlot' nullable: true equipment.SharedIoModule.Response: description: |- The response body of a HTTP GET request for the 'equipment.SharedIoModule' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.SharedIoModule' resources. x-one-of-name: equipment.SharedIoModule.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.SharedIoModule.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.SharedIoModule.Relationship: description: A relationship to the 'equipment.SharedIoModule' resource, or the expanded 'equipment.SharedIoModule' resource, or the 'null' value. x-one-of-name: equipment.SharedIoModule.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.SharedIoModule' equipment.SharedIoModule: title: Equipment:Shared Io Module description: |- I/O Controller present inside SIOC to provide data path from S-series server to FI. x-allOf-name: equipment.SharedIoModule allOf: - # This 'equipment.SharedIoModule' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.SharedIoModule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.SharedIoModule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.SharedIoModule' ObjectType: enum: - 'equipment.SharedIoModule' ConfigState: description: |- This field identifies the configuration state for this SIOM Unit. type: string readOnly: true x-omitempty: true Discovery: description: |- This field identifies the discovery state of SIOM. type: string readOnly: true x-omitempty: true MacOfSharedIomAside: description: |- This field identifies the MAC of IOM-A side. type: string readOnly: true x-omitempty: true MacOfSharedIomBside: description: |- This field identifies the MAC of IOM-B side. type: string readOnly: true x-omitempty: true OperState: description: |- This field identifies the SIOM operational state. type: string readOnly: true x-omitempty: true PartNumber: description: |- This field identifies the Part Number for this SIOM Unit. type: string readOnly: true x-omitempty: true Reachability: description: |- This field identifies the reachability to FI-A and B side. type: string readOnly: true x-omitempty: true UsrLbl: description: |- User label configured for the SIOM. type: string readOnly: true x-omitempty: true Vid: description: |- This field identifies the vendor id for this SIOM Unit. type: string readOnly: true x-omitempty: true Controller: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentSystemIoController: # A Relationship to MO equipment.SystemIoController $ref: '#/components/schemas/equipment.SystemIoController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSystemIoController resource. When the $expand query parameter is specified, the referenced resource is returned inline. InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortGroups: # A Relationship to MO port.Group description: An array of relationships to portGroup resources. type: array items: $ref: '#/components/schemas/port.Group.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.SharedIoModule.List: title: List of 'equipment.SharedIoModule' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.SharedIoModule' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.SharedIoModule' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.SharedIoModule' nullable: true equipment.SwitchCard.Response: description: |- The response body of a HTTP GET request for the 'equipment.SwitchCard' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.SwitchCard' resources. x-one-of-name: equipment.SwitchCard.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.SwitchCard.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.SwitchCard.Relationship: description: A relationship to the 'equipment.SwitchCard' resource, or the expanded 'equipment.SwitchCard' resource, or the 'null' value. x-one-of-name: equipment.SwitchCard.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.SwitchCard' equipment.SwitchCard: title: Equipment:Switch Card description: |- Fixed / Removable module on a Fabric Interconnect / Switch. x-allOf-name: equipment.SwitchCard allOf: - # This 'equipment.SwitchCard' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.SwitchCard' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.SwitchCard', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.SwitchCard' ObjectType: enum: - 'equipment.SwitchCard' Description: description: |- Detailed description of this switch hardware. type: string readOnly: true x-omitempty: true NumPorts: description: |- Number of ports present in this switch hardware. type: integer format: int64 readOnly: true x-omitempty: true OutOfBandIpAddress: description: |- Field specifies this Switch's Out-of-band IP address. type: string readOnly: true x-omitempty: true OutOfBandIpGateway: description: |- Field specifies this Switch's default gateway for the out-of-band management interface. type: string readOnly: true x-omitempty: true Presence: description: |- Presence for this switch hardware. type: string readOnly: true x-omitempty: true SlotId: description: |- Slot identifier of the local Switch slot Interface. type: integer format: int64 readOnly: true x-omitempty: true State: description: |- Operational state of the switch hardware. type: string readOnly: true x-omitempty: true SwitchId: description: |- Switch Identifier that is local to a cluster. type: string readOnly: true x-omitempty: true FcPortChannels: # A Relationship to MO fc.PortChannel description: An array of relationships to fcPortChannel resources. type: array items: $ref: '#/components/schemas/fc.PortChannel.Relationship' nullable: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortChannels: # A Relationship to MO ether.PortChannel description: An array of relationships to etherPortChannel resources. type: array items: $ref: '#/components/schemas/ether.PortChannel.Relationship' nullable: true PortGroups: # A Relationship to MO port.Group description: An array of relationships to portGroup resources. type: array items: $ref: '#/components/schemas/port.Group.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.SwitchCard.List: title: List of 'equipment.SwitchCard' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.SwitchCard' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.SwitchCard' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.SwitchCard' nullable: true equipment.SystemIoController.Response: description: |- The response body of a HTTP GET request for the 'equipment.SystemIoController' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.SystemIoController' resources. x-one-of-name: equipment.SystemIoController.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.SystemIoController.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.SystemIoController.Relationship: description: A relationship to the 'equipment.SystemIoController' resource, or the expanded 'equipment.SystemIoController' resource, or the 'null' value. x-one-of-name: equipment.SystemIoController.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.SystemIoController' equipment.SystemIoController: title: Equipment:System Io Controller description: |- I/O Controller on a chassis which provides the data path to S-series server. x-allOf-name: equipment.SystemIoController allOf: - # This 'equipment.SystemIoController' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.SystemIoController' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.SystemIoController', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.SystemIoController' ObjectType: enum: - 'equipment.SystemIoController' ChassisId: description: |- The assigned identifier for a chassis. type: string readOnly: true x-omitempty: true ConnectionPath: description: |- Connection Path identifies the data path available between IOModule and FI. type: string readOnly: true x-omitempty: true ConnectionStatus: description: |- Connection status identifies the status of data path. type: string readOnly: true x-omitempty: true Description: description: |- This field gives a brief information on systemIOController. type: string readOnly: true x-omitempty: true ManagingInstance: description: |- This field identifies the CIMC that manages the controller. type: string readOnly: true x-omitempty: true OperState: description: |- This field identifies the SIOC operational state. type: string readOnly: true x-omitempty: true PartNumber: description: |- Part Number identifier for the IO module. type: string readOnly: true x-omitempty: true Pid: description: |- This field identifies the Product ID for systemIOController. type: string readOnly: true x-omitempty: true SystemIoControllerId: description: |- This represents system I/O Controller identifier. type: integer format: int64 readOnly: true x-omitempty: true Cmc: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true SharedIoModule: # A Relationship to MO equipment.SharedIoModule $ref: '#/components/schemas/equipment.SharedIoModule.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSharedIoModule resource. When the $expand query parameter is specified, the referenced resource is returned inline. equipment.SystemIoController.List: title: List of 'equipment.SystemIoController' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.SystemIoController' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.SystemIoController' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.SystemIoController' nullable: true equipment.Tpm.Response: description: |- The response body of a HTTP GET request for the 'equipment.Tpm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.Tpm' resources. x-one-of-name: equipment.Tpm.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.Tpm.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.Tpm.Relationship: description: A relationship to the 'equipment.Tpm' resource, or the expanded 'equipment.Tpm' resource, or the 'null' value. x-one-of-name: equipment.Tpm.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/equipment.Tpm' equipment.Tpm: title: Equipment:Tpm description: |- TPM security chip on server board. x-allOf-name: equipment.Tpm allOf: - # This 'equipment.Tpm' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.Tpm' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Tpm', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.Tpm' ObjectType: enum: - 'equipment.Tpm' ActivationStatus: description: |- Identifies the activation status of the TPM. type: string readOnly: true x-omitempty: true AdminState: description: |- Identifies the admin configured state of the TPM. type: string readOnly: true x-omitempty: true Ownership: description: |- Identifies the ownership information of the TPM. type: string readOnly: true x-omitempty: true Presence: description: |- Identifies the presence of the trusted platform module. type: string readOnly: true x-omitempty: true TpmId: description: |- Enter the ID of the trusted platform module. type: integer format: int64 readOnly: true x-omitempty: true Version: description: |- Identifies the revision of the Trusted Platform Module. type: string readOnly: true x-omitempty: true ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.Tpm.List: title: List of 'equipment.Tpm' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.Tpm' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.Tpm' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.Tpm' nullable: true equipment.Transceiver.Response: description: |- The response body of a HTTP GET request for the 'equipment.Transceiver' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'equipment.Transceiver' resources. x-one-of-name: equipment.Transceiver.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/equipment.Transceiver.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType equipment.Transceiver: title: Equipment:Transceiver description: |- Transceiver information on the chassis. x-allOf-name: equipment.Transceiver allOf: - # This 'equipment.Transceiver' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'equipment.Transceiver' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'equipment.Transceiver', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'equipment.Transceiver' ObjectType: enum: - 'equipment.Transceiver' OperSpeed: description: |- Operational speed of the transceiver. type: string readOnly: true x-omitempty: true OperState: description: |- Operational state of the transceiver. type: string readOnly: true x-omitempty: true OperStateQual: description: |- Reason for this transceiver's operational state. type: string readOnly: true x-omitempty: true PortId: description: |- Switch physical port identifier. type: integer format: int64 readOnly: true x-omitempty: true SlotId: description: |- Switch expansion slot module identifier. type: integer format: int64 readOnly: true x-omitempty: true SwitchId: description: |- Switch Identifier that is local to a cluster. type: string readOnly: true x-omitempty: true Type: description: |- The type of the transceiver. type: string readOnly: true x-omitempty: true EtherPhysicalPort: # A Relationship to MO ether.PhysicalPort $ref: '#/components/schemas/ether.PhysicalPort.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a etherPhysicalPort resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true equipment.Transceiver.List: title: List of 'equipment.Transceiver' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'equipment.Transceiver' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'equipment.Transceiver' resources matching the request. type: array items: $ref: '#/components/schemas/equipment.Transceiver' nullable: true ether.HostPort.Response: description: |- The response body of a HTTP GET request for the 'ether.HostPort' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ether.HostPort' resources. x-one-of-name: ether.HostPort.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ether.HostPort.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ether.HostPort.Relationship: description: A relationship to the 'ether.HostPort' resource, or the expanded 'ether.HostPort' resource, or the 'null' value. x-one-of-name: ether.HostPort.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ether.HostPort' ether.HostPort: title: Ether:Host Port description: |- Model object contains the details of host port available on IO card or fabric extender. x-allOf-name: ether.HostPort allOf: - # This 'ether.HostPort' class inherits all properties from its parent class ether.PhysicalPortBase. $ref: '#/components/schemas/ether.PhysicalPortBase' - # The definition of all the properties specified in this 'ether.HostPort' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ether.HostPort', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ether.HostPort' ObjectType: enum: - 'ether.HostPort' ModuleId: description: |- Fabric extender identifier for this port. type: integer format: int64 x-omitempty: true Speed: description: |- Host Port Speed of IO card or fabric extender. type: string readOnly: true x-omitempty: true EquipmentIoCardBase: # A Relationship to MO equipment.IoCardBase $ref: '#/components/schemas/equipment.IoCardBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentIoCardBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ether.HostPort.List: title: List of 'ether.HostPort' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ether.HostPort' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ether.HostPort' resources matching the request. type: array items: $ref: '#/components/schemas/ether.HostPort' nullable: true ether.NetworkPort.Response: description: |- The response body of a HTTP GET request for the 'ether.NetworkPort' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ether.NetworkPort' resources. x-one-of-name: ether.NetworkPort.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ether.NetworkPort.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ether.NetworkPort.Relationship: description: A relationship to the 'ether.NetworkPort' resource, or the expanded 'ether.NetworkPort' resource, or the 'null' value. x-one-of-name: ether.NetworkPort.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ether.NetworkPort' ether.NetworkPort: title: Ether:Network Port description: |- Model contains the details of the ethernet port connected to the FI side. x-allOf-name: ether.NetworkPort allOf: - # This 'ether.NetworkPort' class inherits all properties from its parent class port.InterfaceBase. $ref: '#/components/schemas/port.InterfaceBase' - # The definition of all the properties specified in this 'ether.NetworkPort' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ether.NetworkPort', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ether.NetworkPort' ObjectType: enum: - 'ether.NetworkPort' ModuleId: description: |- Febric extender identifier for this port. type: integer format: int64 x-omitempty: true PeerDn: description: |- Peer DN for network host port of fabric extender. type: string x-omitempty: true PortId: description: |- Switch physical port identifier. type: integer format: int64 x-omitempty: true SlotId: description: |- Switch expansion slot module identifier. type: integer format: int64 x-omitempty: true Speed: description: |- Network Port Speed of IO card or fabric extender. type: string readOnly: true x-omitempty: true SwitchId: description: |- Switch Identifier that is local to a cluster. type: string x-omitempty: true EquipmentIoCardBase: # A Relationship to MO equipment.IoCardBase $ref: '#/components/schemas/equipment.IoCardBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentIoCardBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ether.NetworkPort.List: title: List of 'ether.NetworkPort' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ether.NetworkPort' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ether.NetworkPort' resources matching the request. type: array items: $ref: '#/components/schemas/ether.NetworkPort' nullable: true ether.PhysicalPort.Response: description: |- The response body of a HTTP GET request for the 'ether.PhysicalPort' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ether.PhysicalPort' resources. x-one-of-name: ether.PhysicalPort.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ether.PhysicalPort.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ether.PhysicalPort.Relationship: description: A relationship to the 'ether.PhysicalPort' resource, or the expanded 'ether.PhysicalPort' resource, or the 'null' value. x-one-of-name: ether.PhysicalPort.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ether.PhysicalPort' ether.PhysicalPort: title: Ether:Physical Port description: |- Physical ethernet port present on a FI. x-allOf-name: ether.PhysicalPort allOf: - # This 'ether.PhysicalPort' class inherits all properties from its parent class ether.PhysicalPortBase. $ref: '#/components/schemas/ether.PhysicalPortBase' - # The definition of all the properties specified in this 'ether.PhysicalPort' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ether.PhysicalPort', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ether.PhysicalPort' ObjectType: enum: - 'ether.PhysicalPort' AdminSpeed: description: |- Administratively configured speed for this port. type: string readOnly: true x-omitempty: true AdminState: description: |- Administratively configured state (enabled/disabled) for this port. type: string readOnly: true x-omitempty: true AggregatePortId: description: |- Breakout port member in the Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true LicenseGrace: description: |- The number of days this port's license has been in Grace Period for. type: string readOnly: true x-omitempty: true LicenseState: description: |- The state of the port's licensing. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortGroup: # A Relationship to MO port.Group $ref: '#/components/schemas/port.Group.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a portGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortSubGroup: # A Relationship to MO port.SubGroup $ref: '#/components/schemas/port.SubGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a portSubGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ether.PhysicalPort.List: title: List of 'ether.PhysicalPort' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ether.PhysicalPort' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ether.PhysicalPort' resources matching the request. type: array items: $ref: '#/components/schemas/ether.PhysicalPort' nullable: true ether.PhysicalPortBase.Relationship: description: A relationship to the 'ether.PhysicalPortBase' resource, or the expanded 'ether.PhysicalPortBase' resource, or the 'null' value. x-one-of-name: ether.PhysicalPortBase.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ether.PhysicalPortBase' ether.PhysicalPortBase: title: Ether:Physical Port Base description: |- Abstract class for ether physical port and host port. x-allOf-name: ether.PhysicalPortBase allOf: - # This 'ether.PhysicalPortBase' class inherits all properties from its parent class port.Physical. $ref: '#/components/schemas/port.Physical' - # The definition of all the properties specified in this 'ether.PhysicalPortBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ether.PhysicalPortBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: MacAddress: description: |- Mac Address of a port in the Fabric Interconnect. type: string readOnly: true x-omitempty: true Mode: description: |- Operating mode of this port. type: string readOnly: true x-omitempty: true OperSpeed: description: |- Current Operational speed for this port. type: string readOnly: true x-omitempty: true PeerDn: description: |- PeerDn for ethernet physical port. type: string readOnly: true x-omitempty: true PortChannelId: description: |- Port channel id for port channel created on FI switch. type: integer format: int64 readOnly: true x-omitempty: true PortType: description: |- Defines the transport type for this port (ethernet OR fc). type: string readOnly: true x-omitempty: true TransceiverType: description: |- Transceiver model attached to a port in the Fabric Interconnect. type: string readOnly: true x-omitempty: true AcknowledgedPeerInterface: # A Relationship to MO port.InterfaceBase $ref: '#/components/schemas/port.InterfaceBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a portInterfaceBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. PeerInterface: # A Relationship to MO port.InterfaceBase $ref: '#/components/schemas/port.InterfaceBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a portInterfaceBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. ether.PortChannel.Response: description: |- The response body of a HTTP GET request for the 'ether.PortChannel' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ether.PortChannel' resources. x-one-of-name: ether.PortChannel.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ether.PortChannel.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ether.PortChannel.Relationship: description: A relationship to the 'ether.PortChannel' resource, or the expanded 'ether.PortChannel' resource, or the 'null' value. x-one-of-name: ether.PortChannel.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ether.PortChannel' ether.PortChannel: title: Ether:Port Channel description: |- Model contains the details of the ethernet port-channels configured on the FI. x-allOf-name: ether.PortChannel allOf: - # This 'ether.PortChannel' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'ether.PortChannel' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ether.PortChannel', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ether.PortChannel' ObjectType: enum: - 'ether.PortChannel' AccessVlan: description: |- Access VLANs for this port-channel, on this FI. type: string x-omitempty: true AdminState: description: |- Administratively configured state (enabled/disabled) for this port-channel. type: string x-omitempty: true AllowedVlans: description: |- Allowed VLANs on this port-channel, on this FI. type: string x-omitempty: true Mode: description: |- Operating mode of this port-channel. type: string x-omitempty: true NativeVlan: description: |- Native VLAN for this port-channel, on this FI. type: string x-omitempty: true OperSpeed: description: |- Operational speed of this port-channel. type: string x-omitempty: true OperState: description: |- Operational state of this port-channel. type: string x-omitempty: true OperStateQual: description: |- Reason for this port-channel's Operational state. type: string x-omitempty: true PortChannelId: description: |- Unique identifier for this port-channel on the FI. type: integer format: int64 x-omitempty: true Role: description: |- This port-channel's configured role (uplink, server, etc.). type: string x-omitempty: true SwitchId: description: |- Switch Identifier that is local to a cluster. type: string x-omitempty: true EquipmentSwitchCard: # A Relationship to MO equipment.SwitchCard $ref: '#/components/schemas/equipment.SwitchCard.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSwitchCard resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ether.PortChannel.List: title: List of 'ether.PortChannel' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ether.PortChannel' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ether.PortChannel' resources matching the request. type: array items: $ref: '#/components/schemas/ether.PortChannel' nullable: true externalsite.Authorization.Response: description: |- The response body of a HTTP GET request for the 'externalsite.Authorization' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'externalsite.Authorization' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'externalsite.Authorization' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'externalsite.Authorization', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'externalsite.Authorization' ObjectType: enum: - 'externalsite.Authorization' IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true IsUserIdSet: description: |- Indicates whether the value of the 'userId' property has been set. type: boolean 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. * `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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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 fabric.ConfigChangeDetail.Response: description: |- The response body of a HTTP GET request for the 'fabric.ConfigChangeDetail' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.ConfigChangeDetail' resources. x-one-of-name: fabric.ConfigChangeDetail.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.ConfigChangeDetail.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.ConfigChangeDetail.Relationship: description: A relationship to the 'fabric.ConfigChangeDetail' resource, or the expanded 'fabric.ConfigChangeDetail' resource, or the 'null' value. x-one-of-name: fabric.ConfigChangeDetail.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.ConfigChangeDetail' fabric.ConfigChangeDetail: title: Fabric:Config Change Detail description: |- This captures details of configuration changes. x-allOf-name: fabric.ConfigChangeDetail allOf: - # This 'fabric.ConfigChangeDetail' class inherits all properties from its parent class policy.AbstractConfigChangeDetail. $ref: '#/components/schemas/policy.AbstractConfigChangeDetail' - # The definition of all the properties specified in this 'fabric.ConfigChangeDetail' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.ConfigChangeDetail', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.ConfigChangeDetail' ObjectType: enum: - 'fabric.ConfigChangeDetail' Profile: # A Relationship to MO fabric.SwitchProfile $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricSwitchProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fabric.ConfigChangeDetail.List: title: List of 'fabric.ConfigChangeDetail' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.ConfigChangeDetail' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.ConfigChangeDetail' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.ConfigChangeDetail' nullable: true fabric.ConfigResult.Response: description: |- The response body of a HTTP GET request for the 'fabric.ConfigResult' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.ConfigResult' resources. x-one-of-name: fabric.ConfigResult.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.ConfigResult.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.ConfigResult.Relationship: description: A relationship to the 'fabric.ConfigResult' resource, or the expanded 'fabric.ConfigResult' resource, or the 'null' value. x-one-of-name: fabric.ConfigResult.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.ConfigResult' fabric.ConfigResult: title: Fabric:Config Result description: |- This provides overall state and detailed information for the deploy and validation profile configuration results. x-allOf-name: fabric.ConfigResult allOf: - # This 'fabric.ConfigResult' class inherits all properties from its parent class policy.AbstractConfigResult. $ref: '#/components/schemas/policy.AbstractConfigResult' - # The definition of all the properties specified in this 'fabric.ConfigResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.ConfigResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.ConfigResult' ObjectType: enum: - 'fabric.ConfigResult' Profile: # A Relationship to MO fabric.SwitchProfile $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricSwitchProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ResultEntries: # A Relationship to MO fabric.ConfigResultEntry description: An array of relationships to fabricConfigResultEntry resources. type: array items: $ref: '#/components/schemas/fabric.ConfigResultEntry.Relationship' nullable: true fabric.ConfigResult.List: title: List of 'fabric.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 'fabric.ConfigResult' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.ConfigResult' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.ConfigResult' nullable: true fabric.ConfigResultEntry.Response: description: |- The response body of a HTTP GET request for the 'fabric.ConfigResultEntry' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.ConfigResultEntry' resources. x-one-of-name: fabric.ConfigResultEntry.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.ConfigResultEntry.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.ConfigResultEntry.Relationship: description: A relationship to the 'fabric.ConfigResultEntry' resource, or the expanded 'fabric.ConfigResultEntry' resource, or the 'null' value. x-one-of-name: fabric.ConfigResultEntry.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.ConfigResultEntry' fabric.ConfigResultEntry: title: Fabric:Config Result Entry description: |- This provides detailed information for the deploy and validation profile configuration results. x-allOf-name: fabric.ConfigResultEntry allOf: - # This 'fabric.ConfigResultEntry' class inherits all properties from its parent class policy.AbstractConfigResultEntry. $ref: '#/components/schemas/policy.AbstractConfigResultEntry' - # The definition of all the properties specified in this 'fabric.ConfigResultEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.ConfigResultEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.ConfigResultEntry' ObjectType: enum: - 'fabric.ConfigResultEntry' ConfigResult: # A Relationship to MO fabric.ConfigResult $ref: '#/components/schemas/fabric.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.ConfigResultEntry.List: title: List of 'fabric.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 'fabric.ConfigResultEntry' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.ConfigResultEntry' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.ConfigResultEntry' nullable: true fabric.EstimateImpact: title: Fabric:Estimate Impact description: |- Before submitting switch profile deploy operation, the estimate impact helps to know the list of components be impacted and require switch reboot. x-allOf-name: fabric.EstimateImpact allOf: - # This 'fabric.EstimateImpact' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.EstimateImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.EstimateImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.EstimateImpact' ObjectType: enum: - 'fabric.EstimateImpact' Profile: # A Relationship to MO fabric.SwitchProfile $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricSwitchProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.EthNetworkControlPolicy.Response: description: |- The response body of a HTTP GET request for the 'fabric.EthNetworkControlPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.EthNetworkControlPolicy' resources. x-one-of-name: fabric.EthNetworkControlPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.EthNetworkControlPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.EthNetworkControlPolicy.Relationship: description: A relationship to the 'fabric.EthNetworkControlPolicy' resource, or the expanded 'fabric.EthNetworkControlPolicy' resource, or the 'null' value. x-one-of-name: fabric.EthNetworkControlPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' fabric.EthNetworkControlPolicy: title: Ethernet Network Control description: |- The features that are applied on a vethernet that is connected to the vNIC. x-allOf-name: fabric.EthNetworkControlPolicy allOf: - # This 'fabric.EthNetworkControlPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'fabric.EthNetworkControlPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.EthNetworkControlPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.EthNetworkControlPolicy' ObjectType: enum: - 'fabric.EthNetworkControlPolicy' CdpEnabled: description: |- Enables the CDP on an interface. type: boolean x-omitempty: true ForgeMac: description: |- Determines if the MAC forging is allowed or denied on an interface. * `allow` - Allows mac forging on an interface. * `deny` - Denies mac forging on an interface. type: string enum: - 'allow' - 'deny' default: allow x-omitempty: true LldpSettings: description: |- Determines the LLDP setting on an interface on the switch. $ref: '#/components/schemas/fabric.LldpSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MacRegistrationMode: description: |- Determines the MAC addresses that have to be registered with the switch. * `nativeVlanOnly` - Register only the MAC addresses learnt on the native VLAN. * `allVlans` - Register all the MAC addresses learnt on all the allowed VLANs. type: string enum: - 'nativeVlanOnly' - 'allVlans' default: nativeVlanOnly x-omitempty: true UplinkFailAction: description: |- Determines the state of the virtual interface (vethernet / vfc) on the switch when a suitable uplink is not pinned. * `linkDown` - The vethernet will go down in case a suitable uplink is not pinned. * `warning` - The vethernet will remain up even if a suitable uplink is not pinned. type: string enum: - 'linkDown' - 'warning' default: linkDown x-omitempty: true NetworkPolicy: # A Relationship to MO vnic.EthNetworkPolicy description: An array of relationships to vnicEthNetworkPolicy resources. type: array items: $ref: '#/components/schemas/vnic.EthNetworkPolicy.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true fabric.EthNetworkControlPolicy.List: title: List of 'fabric.EthNetworkControlPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.EthNetworkControlPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.EthNetworkControlPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.EthNetworkControlPolicy' nullable: true fabric.EthNetworkGroupPolicy.Response: description: |- The response body of a HTTP GET request for the 'fabric.EthNetworkGroupPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.EthNetworkGroupPolicy' resources. x-one-of-name: fabric.EthNetworkGroupPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.EthNetworkGroupPolicy.Relationship: description: A relationship to the 'fabric.EthNetworkGroupPolicy' resource, or the expanded 'fabric.EthNetworkGroupPolicy' resource, or the 'null' value. x-one-of-name: fabric.EthNetworkGroupPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' fabric.EthNetworkGroupPolicy: title: Ethernet Network Group description: |- The allowed VLAN/s on an interface. x-allOf-name: fabric.EthNetworkGroupPolicy allOf: - # This 'fabric.EthNetworkGroupPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'fabric.EthNetworkGroupPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.EthNetworkGroupPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.EthNetworkGroupPolicy' ObjectType: enum: - 'fabric.EthNetworkGroupPolicy' VlanSettings: description: |- VLAN configuration for the virtual interface. $ref: '#/components/schemas/fabric.VlanSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true fabric.EthNetworkGroupPolicy.List: title: List of 'fabric.EthNetworkGroupPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.EthNetworkGroupPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.EthNetworkGroupPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy' nullable: true fabric.EthNetworkPolicy.Response: description: |- The response body of a HTTP GET request for the 'fabric.EthNetworkPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.EthNetworkPolicy' resources. x-one-of-name: fabric.EthNetworkPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.EthNetworkPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.EthNetworkPolicy.Relationship: description: A relationship to the 'fabric.EthNetworkPolicy' resource, or the expanded 'fabric.EthNetworkPolicy' resource, or the 'null' value. x-one-of-name: fabric.EthNetworkPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.EthNetworkPolicy' fabric.EthNetworkPolicy: title: VLAN Configuration description: |- A policy for all the Virtual LAN networks to be deployed on the Fabric Interconnect. x-allOf-name: fabric.EthNetworkPolicy allOf: - # This 'fabric.EthNetworkPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'fabric.EthNetworkPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.EthNetworkPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.EthNetworkPolicy' ObjectType: enum: - 'fabric.EthNetworkPolicy' Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO fabric.SwitchProfile description: An array of relationships to fabricSwitchProfile resources. type: array items: $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' nullable: true fabric.EthNetworkPolicy.List: title: List of 'fabric.EthNetworkPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.EthNetworkPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.EthNetworkPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.EthNetworkPolicy' nullable: true fabric.FcNetworkPolicy.Response: description: |- The response body of a HTTP GET request for the 'fabric.FcNetworkPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.FcNetworkPolicy' resources. x-one-of-name: fabric.FcNetworkPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.FcNetworkPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.FcNetworkPolicy.Relationship: description: A relationship to the 'fabric.FcNetworkPolicy' resource, or the expanded 'fabric.FcNetworkPolicy' resource, or the 'null' value. x-one-of-name: fabric.FcNetworkPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.FcNetworkPolicy' fabric.FcNetworkPolicy: title: VSAN Configuration description: |- A policy for all the Virtual SAN networks to be deployed on the Fabric Interconnect. x-allOf-name: fabric.FcNetworkPolicy allOf: - # This 'fabric.FcNetworkPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'fabric.FcNetworkPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.FcNetworkPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.FcNetworkPolicy' ObjectType: enum: - 'fabric.FcNetworkPolicy' EnableTrunking: description: |- Enable or Disable Trunking on all of configured FC uplink ports. type: boolean x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO fabric.SwitchProfile description: An array of relationships to fabricSwitchProfile resources. type: array items: $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' nullable: true fabric.FcNetworkPolicy.List: title: List of 'fabric.FcNetworkPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.FcNetworkPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.FcNetworkPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.FcNetworkPolicy' nullable: true fabric.FcUplinkPcRole.Response: description: |- The response body of a HTTP GET request for the 'fabric.FcUplinkPcRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.FcUplinkPcRole' resources. x-one-of-name: fabric.FcUplinkPcRole.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.FcUplinkPcRole.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.FcUplinkPcRole: title: Fabric:Fc Uplink Pc Role description: |- Object sent by user to configure a fc uplink port-channel on the collection of ports. x-allOf-name: fabric.FcUplinkPcRole allOf: - # This 'fabric.FcUplinkPcRole' class inherits all properties from its parent class fabric.PortChannelRole. $ref: '#/components/schemas/fabric.PortChannelRole' - # The definition of all the properties specified in this 'fabric.FcUplinkPcRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.FcUplinkPcRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.FcUplinkPcRole' ObjectType: enum: - 'fabric.FcUplinkPcRole' AdminSpeed: description: |- Admin configured speed for the port. * `Auto` - Admin configurable speed AUTO ( default ). * `8Gbps` - Admin configurable speed 8Gbps. * `16Gbps` - Admin configurable speed 16Gbps. * `32Gbps` - Admin configurable speed 32Gbps. type: string enum: - 'Auto' - '8Gbps' - '16Gbps' - '32Gbps' default: Auto x-omitempty: true FillPattern: description: |- Fill pattern to differentiate the configs in NPIV. * `Idle` - Fc Fill Pattern type Idle. * `Arbff` - Fc Fill Pattern type Arbff. type: string enum: - 'Idle' - 'Arbff' default: Idle x-omitempty: true VsanId: description: |- Virtual San Identifier associated to the FC port. type: integer format: int64 minimum: 1 maximum: 4093 x-omitempty: true fabric.FcUplinkPcRole.List: title: List of 'fabric.FcUplinkPcRole' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.FcUplinkPcRole' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.FcUplinkPcRole' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.FcUplinkPcRole' nullable: true fabric.FcUplinkRole.Response: description: |- The response body of a HTTP GET request for the 'fabric.FcUplinkRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.FcUplinkRole' resources. x-one-of-name: fabric.FcUplinkRole.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.FcUplinkRole.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.FcUplinkRole: title: Fabric:Fc Uplink Role description: |- Configuration object sent by user to create a fc uplink port. x-allOf-name: fabric.FcUplinkRole allOf: - # This 'fabric.FcUplinkRole' class inherits all properties from its parent class fabric.PortRole. $ref: '#/components/schemas/fabric.PortRole' - # The definition of all the properties specified in this 'fabric.FcUplinkRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.FcUplinkRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.FcUplinkRole' ObjectType: enum: - 'fabric.FcUplinkRole' AdminSpeed: description: |- Admin configured speed for the port. * `Auto` - Admin configurable speed AUTO ( default ). * `8Gbps` - Admin configurable speed 8Gbps. * `16Gbps` - Admin configurable speed 16Gbps. * `32Gbps` - Admin configurable speed 32Gbps. type: string enum: - 'Auto' - '8Gbps' - '16Gbps' - '32Gbps' default: Auto x-omitempty: true FillPattern: description: |- Fill pattern to differentiate the configs in NPIV. * `Idle` - Fc Fill Pattern type Idle. * `Arbff` - Fc Fill Pattern type Arbff. type: string enum: - 'Idle' - 'Arbff' default: Idle x-omitempty: true VsanId: description: |- Virtual San Identifier associated to the FC port. type: integer format: int64 minimum: 1 maximum: 4093 x-omitempty: true fabric.FcUplinkRole.List: title: List of 'fabric.FcUplinkRole' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.FcUplinkRole' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.FcUplinkRole' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.FcUplinkRole' nullable: true fabric.FcoeUplinkPcRole.Response: description: |- The response body of a HTTP GET request for the 'fabric.FcoeUplinkPcRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.FcoeUplinkPcRole' resources. x-one-of-name: fabric.FcoeUplinkPcRole.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.FcoeUplinkPcRole.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.FcoeUplinkPcRole: title: Fabric:Fcoe Uplink Pc Role description: |- Object sent by user to configure a fcoe uplink port-channel on the collection of ports. x-allOf-name: fabric.FcoeUplinkPcRole allOf: - # This 'fabric.FcoeUplinkPcRole' class inherits all properties from its parent class fabric.PortChannelRole. $ref: '#/components/schemas/fabric.PortChannelRole' - # The definition of all the properties specified in this 'fabric.FcoeUplinkPcRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.FcoeUplinkPcRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.FcoeUplinkPcRole' ObjectType: enum: - 'fabric.FcoeUplinkPcRole' AdminSpeed: description: |- Admin configured speed for the port. * `Auto` - Admin configurable speed AUTO ( default ). * `1Gbps` - Admin configurable speed 1Gbps. * `10Gbps` - Admin configurable speed 10Gbps. * `25Gbps` - Admin configurable speed 25Gbps. * `40Gbps` - Admin configurable speed 40Gbps. * `100Gbps` - Admin configurable speed 100Gbps. type: string enum: - 'Auto' - '1Gbps' - '10Gbps' - '25Gbps' - '40Gbps' - '100Gbps' default: Auto x-omitempty: true UdldAdminState: description: |- Admin configured state for UDLD for this port. * `Disabled` - Admin configured Disabled State. * `Enabled` - Admin configured Enabled State. type: string enum: - 'Disabled' - 'Enabled' default: Disabled x-omitempty: true fabric.FcoeUplinkPcRole.List: title: List of 'fabric.FcoeUplinkPcRole' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.FcoeUplinkPcRole' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.FcoeUplinkPcRole' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.FcoeUplinkPcRole' nullable: true fabric.FcoeUplinkRole.Response: description: |- The response body of a HTTP GET request for the 'fabric.FcoeUplinkRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.FcoeUplinkRole' resources. x-one-of-name: fabric.FcoeUplinkRole.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.FcoeUplinkRole.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.FcoeUplinkRole: title: Fabric:Fcoe Uplink Role description: |- Configuration object sent by user to create a fcoe uplink port. x-allOf-name: fabric.FcoeUplinkRole allOf: - # This 'fabric.FcoeUplinkRole' class inherits all properties from its parent class fabric.PortRole. $ref: '#/components/schemas/fabric.PortRole' - # The definition of all the properties specified in this 'fabric.FcoeUplinkRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.FcoeUplinkRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.FcoeUplinkRole' ObjectType: enum: - 'fabric.FcoeUplinkRole' AdminSpeed: description: |- Admin configured speed for the port. * `Auto` - Admin configurable speed AUTO ( default ). * `1Gbps` - Admin configurable speed 1Gbps. * `10Gbps` - Admin configurable speed 10Gbps. * `25Gbps` - Admin configurable speed 25Gbps. * `40Gbps` - Admin configurable speed 40Gbps. * `100Gbps` - Admin configurable speed 100Gbps. type: string enum: - 'Auto' - '1Gbps' - '10Gbps' - '25Gbps' - '40Gbps' - '100Gbps' default: Auto x-omitempty: true Fec: description: |- Forward error correction configuration for the port. * `Auto` - Forward error correction option 'Auto'. * `Cl91` - Forward error correction option 'cl91'. * `Cl74` - Forward error correction option 'cl74'. type: string enum: - 'Auto' - 'Cl91' - 'Cl74' default: Auto x-omitempty: true UdldAdminState: description: |- Admin configured state for UDLD for this port. * `Disabled` - Admin configured Disabled State. * `Enabled` - Admin configured Enabled State. type: string enum: - 'Disabled' - 'Enabled' default: Disabled x-omitempty: true fabric.FcoeUplinkRole.List: title: List of 'fabric.FcoeUplinkRole' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.FcoeUplinkRole' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.FcoeUplinkRole' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.FcoeUplinkRole' nullable: true fabric.LldpSettings: title: LLDP Settings description: |- The LLDP settings on an interface on the switch. x-allOf-name: fabric.LldpSettings allOf: - # This 'fabric.LldpSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'fabric.LldpSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.LldpSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.LldpSettings' ObjectType: enum: - 'fabric.LldpSettings' ReceiveEnabled: description: |- Determines if the LLDP frames can be received by an interface on the switch. type: boolean x-omitempty: true TransmitEnabled: description: |- Determines if the LLDP frames can be transmitted by an interface on the switch. type: boolean x-omitempty: true fabric.PcMember.Response: description: |- The response body of a HTTP GET request for the 'fabric.PcMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.PcMember' resources. x-one-of-name: fabric.PcMember.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.PcMember.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.PcMember: title: Fabric:Pc Member description: |- PcMember object is to establish the relationship between port parameters and pcId. x-allOf-name: fabric.PcMember allOf: - # This 'fabric.PcMember' class inherits all properties from its parent class fabric.PortBase. $ref: '#/components/schemas/fabric.PortBase' - # The definition of all the properties specified in this 'fabric.PcMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PcMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.PcMember' ObjectType: enum: - 'fabric.PcMember' PcId: description: |- Port Channel Identifier for the collection of ports. type: integer format: int64 x-omitempty: true PortPolicy: # A Relationship to MO fabric.PortPolicy $ref: '#/components/schemas/fabric.PortPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricPortPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fabric.PcMember.List: title: List of 'fabric.PcMember' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.PcMember' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.PcMember' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.PcMember' nullable: true fabric.PcOperation.Response: description: |- The response body of a HTTP GET request for the 'fabric.PcOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.PcOperation' resources. x-one-of-name: fabric.PcOperation.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.PcOperation.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.PcOperation: title: Fabric:Pc Operation description: |- PcOperation objects allows the user to alter the state of the port channel. x-allOf-name: fabric.PcOperation allOf: - # This 'fabric.PcOperation' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.PcOperation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PcOperation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.PcOperation' ObjectType: enum: - 'fabric.PcOperation' AdminState: description: |- Admin configured state to disable the port channel. * `Enabled` - Admin configured Enabled State. * `Disabled` - Admin configured Disabled State. type: string enum: - 'Enabled' - 'Disabled' default: Enabled x-omitempty: true PcId: description: |- Port Channel Identifier for the collection of ports. type: integer format: int64 x-omitempty: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.PcOperation.List: title: List of 'fabric.PcOperation' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.PcOperation' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.PcOperation' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.PcOperation' nullable: true fabric.PortBase: title: Fabric:Port Base description: |- Abstract representation of Switch/FEX/Chassis Port. x-allOf-name: fabric.PortBase allOf: - # This 'fabric.PortBase' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.PortBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PortBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AggregatePortId: description: |- Breakout port Identifier of the Switch Interface. type: integer format: int64 x-omitempty: true PortId: description: |- Port Identifier of the Switch/FEX/Chassis Interface. type: integer format: int64 x-omitempty: true SlotId: description: |- Slot Identifier of the Switch/FEX/Chassis Interface. type: integer format: int64 x-omitempty: true fabric.PortChannelRole: title: Fabric:Port Channel Role description: |- Configuration object sent by user to apply on a port-channel. x-allOf-name: fabric.PortChannelRole allOf: - # This 'fabric.PortChannelRole' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.PortChannelRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PortChannelRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: PcId: description: |- Unique Identifier of the port-channel, local to this switch. type: integer format: int64 minimum: 1 maximum: 256 x-omitempty: true Ports: type: array items: description: |- Collection of switch ports that will be part of port channel. $ref: '#/components/schemas/fabric.PortIdentifier' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PortPolicy: # A Relationship to MO fabric.PortPolicy $ref: '#/components/schemas/fabric.PortPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricPortPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.PortIdentifier: title: Fabric:Port Identifier description: |- Type to represent switch ports. x-allOf-name: fabric.PortIdentifier allOf: - # This 'fabric.PortIdentifier' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'fabric.PortIdentifier' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PortIdentifier', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.PortIdentifier' ObjectType: enum: - 'fabric.PortIdentifier' AggregatePortId: description: |- Breakout port Identifier of the Switch Interface. type: integer format: int64 minimum: 0 maximum: 108 x-omitempty: true PortId: description: |- Port Identifier of the Switch/FEX/Chassis Interface. type: integer format: int64 minimum: 1 maximum: 108 x-omitempty: true SlotId: description: |- Slot Identifier of the Switch/FEX/Chassis Interface. type: integer format: int64 minimum: 1 maximum: 5 x-omitempty: true fabric.PortMode.Response: description: |- The response body of a HTTP GET request for the 'fabric.PortMode' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.PortMode' resources. x-one-of-name: fabric.PortMode.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.PortMode.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.PortMode: title: Fabric:Port Mode description: |- Object sent by user to configure range of unified ports as FC/Ethernet or ports as breakout. x-allOf-name: fabric.PortMode allOf: - # This 'fabric.PortMode' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.PortMode' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PortMode', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.PortMode' ObjectType: enum: - 'fabric.PortMode' CustomMode: description: |- Custom Port Mode specified for the port range. * `FibreChannel` - Fibre Channel Port Types. * `BreakoutEthernet10G` - Breakout Ethernet 10G Port Type. * `BreakoutEthernet25G` - Breakout Ethernet 25G Port Type. type: string enum: - 'FibreChannel' - 'BreakoutEthernet10G' - 'BreakoutEthernet25G' default: FibreChannel x-omitempty: true PortIdEnd: description: |- Ending range of the Port Identifier. type: integer format: int64 x-omitempty: true PortIdStart: description: |- Starting range of the Port Identifier. type: integer format: int64 x-omitempty: true SlotId: description: |- Slot Identifier of the switch. type: integer format: int64 x-omitempty: true PortPolicy: # A Relationship to MO fabric.PortPolicy $ref: '#/components/schemas/fabric.PortPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricPortPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.PortMode.List: title: List of 'fabric.PortMode' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.PortMode' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.PortMode' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.PortMode' nullable: true fabric.PortOperation.Response: description: |- The response body of a HTTP GET request for the 'fabric.PortOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.PortOperation' resources. x-one-of-name: fabric.PortOperation.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.PortOperation.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.PortOperation: title: Fabric:Port Operation description: |- PortOperation objects allows the user to alter the state of the port. x-allOf-name: fabric.PortOperation allOf: - # This 'fabric.PortOperation' class inherits all properties from its parent class fabric.PortBase. $ref: '#/components/schemas/fabric.PortBase' - # The definition of all the properties specified in this 'fabric.PortOperation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PortOperation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.PortOperation' ObjectType: enum: - 'fabric.PortOperation' AdminState: description: |- Admin configured state to disable the port. * `Enabled` - Admin configured Enabled State. * `Disabled` - Admin configured Disabled State. type: string enum: - 'Enabled' - 'Disabled' default: Enabled x-omitempty: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.PortOperation.List: title: List of 'fabric.PortOperation' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.PortOperation' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.PortOperation' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.PortOperation' nullable: true fabric.PortPolicy.Response: description: |- The response body of a HTTP GET request for the 'fabric.PortPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.PortPolicy' resources. x-one-of-name: fabric.PortPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.PortPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.PortPolicy.Relationship: description: A relationship to the 'fabric.PortPolicy' resource, or the expanded 'fabric.PortPolicy' resource, or the 'null' value. x-one-of-name: fabric.PortPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.PortPolicy' fabric.PortPolicy: title: Port description: |- A policy for all the physical ports of the Fabric Interconnect. x-allOf-name: fabric.PortPolicy allOf: - # This 'fabric.PortPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'fabric.PortPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PortPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.PortPolicy' ObjectType: enum: - 'fabric.PortPolicy' DeviceModel: description: |- This field specifies the device model that this Port Policy is being configured for. * `UCS-FI-6454` - The standard 4th generation UCS Fabric Interconnect with 54 ports. * `UCS-FI-64108` - The expanded 4th generation UCS Fabric Interconnect with 108 ports. * `unknown` - Unknown device type, usage is TBD. type: string enum: - 'UCS-FI-6454' - 'UCS-FI-64108' - 'unknown' default: UCS-FI-6454 x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO fabric.SwitchProfile description: An array of relationships to fabricSwitchProfile resources. type: array items: $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' nullable: true fabric.PortPolicy.List: title: List of 'fabric.PortPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.PortPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.PortPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.PortPolicy' nullable: true fabric.PortRole: title: Fabric:Port Role description: |- Configuration object sent by user to apply on a port. x-allOf-name: fabric.PortRole allOf: - # This 'fabric.PortRole' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.PortRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.PortRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AggregatePortId: description: |- Breakout port Identifier of the Switch Interface. type: integer format: int64 minimum: 1 maximum: 108 x-omitempty: true PortId: description: |- Port Identifier of the Switch/FEX/Chassis Interface. type: integer format: int64 minimum: 1 maximum: 108 x-omitempty: true SlotId: description: |- Slot Identifier of the Switch/FEX/Chassis Interface. type: integer format: int64 minimum: 1 maximum: 5 x-omitempty: true PortPolicy: # A Relationship to MO fabric.PortPolicy $ref: '#/components/schemas/fabric.PortPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricPortPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.QosClass: title: Fabric:Qos Class description: |- Type to represent the Best Effort QoS class. x-allOf-name: fabric.QosClass allOf: - # This 'fabric.QosClass' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'fabric.QosClass' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.QosClass', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.QosClass' ObjectType: enum: - 'fabric.QosClass' AdminState: description: |- Administrative state for this QoS class. * `Disabled` - Admin configured Disabled State. * `Enabled` - Admin configured Enabled State. type: string enum: - 'Disabled' - 'Enabled' default: Disabled x-omitempty: true BandwidthPercent: description: |- Percentage of bandwidth received by the traffic tagged with this QoS. type: integer format: int64 minimum: 0 maximum: 100 x-omitempty: true Cos: description: |- Class of service received by the traffic tagged with this QoS. type: integer format: int64 minimum: 0 maximum: 255 x-omitempty: true Mtu: description: |- Maximum transmission unit (MTU) is the largest size packet or frame, that can be sent in a packet- or frame-based network such as the Internet. User can select from the following: 1. Any value between 1500 and 9216 2. 'Normal' (default) mapping to a value of 1500. 3. 'FC' mapping to a value of 2240. type: integer format: int64 minimum: 1500 maximum: 9216 x-omitempty: true MulticastOptimize: description: |- If enabled, this QoS class will be optimized to send multiple packets. type: boolean x-omitempty: true Name: description: |- The 'name' of this QoS Class. * `Best Effort` - QoS Priority for Best-effort traffic. * `FC` - QoS Priority for FC traffic. * `Platinum` - QoS Priority for Platinum traffic. * `Gold` - QoS Priority for Gold traffic. * `Silver` - QoS Priority for Silver traffic. * `Bronze` - QoS Priority for Bronze traffic. type: string enum: - 'Best Effort' - 'FC' - 'Platinum' - 'Gold' - 'Silver' - 'Bronze' default: Best Effort x-omitempty: true PacketDrop: description: |- If enabled, this QoS class will allow packet drops within an acceptable limit. type: boolean x-omitempty: true Weight: description: |- The weight of the QoS Class controls the distribution of bandwidth between QoS Classes, with the same priority after the Guarantees for the QoS Classes are reached. type: integer format: int64 minimum: 0 maximum: 10 x-omitempty: true fabric.ServerRole.Response: description: |- The response body of a HTTP GET request for the 'fabric.ServerRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.ServerRole' resources. x-one-of-name: fabric.ServerRole.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.ServerRole.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.ServerRole: title: Fabric:Server Role description: |- Configuration object sent by user to create a server port. x-allOf-name: fabric.ServerRole allOf: - # This 'fabric.ServerRole' class inherits all properties from its parent class fabric.PortRole. $ref: '#/components/schemas/fabric.PortRole' - # The definition of all the properties specified in this 'fabric.ServerRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.ServerRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.ServerRole' ObjectType: enum: - 'fabric.ServerRole' Fec: description: |- Forward error correction configuration for the port. * `Auto` - Forward error correction option 'Auto'. * `Cl91` - Forward error correction option 'cl91'. * `Cl74` - Forward error correction option 'cl74'. type: string enum: - 'Auto' - 'Cl91' - 'Cl74' default: Auto x-omitempty: true fabric.ServerRole.List: title: List of 'fabric.ServerRole' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.ServerRole' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.ServerRole' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.ServerRole' nullable: true fabric.SwitchClusterProfile.Response: description: |- The response body of a HTTP GET request for the 'fabric.SwitchClusterProfile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.SwitchClusterProfile' resources. x-one-of-name: fabric.SwitchClusterProfile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.SwitchClusterProfile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.SwitchClusterProfile.Relationship: description: A relationship to the 'fabric.SwitchClusterProfile' resource, or the expanded 'fabric.SwitchClusterProfile' resource, or the 'null' value. x-one-of-name: fabric.SwitchClusterProfile.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.SwitchClusterProfile' fabric.SwitchClusterProfile: title: Switch Cluster Profile description: |- This specifies the configuration policies for a cluster of switches. x-allOf-name: fabric.SwitchClusterProfile allOf: - # This 'fabric.SwitchClusterProfile' class inherits all properties from its parent class policy.AbstractProfile. $ref: '#/components/schemas/policy.AbstractProfile' - # The definition of all the properties specified in this 'fabric.SwitchClusterProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.SwitchClusterProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.SwitchClusterProfile' ObjectType: enum: - 'fabric.SwitchClusterProfile' ConfigContext: description: |- This provides consolidated configuration context of all the switch profiles referred by Switch Cluster Profile. $ref: '#/components/schemas/policy.ConfigContext' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true SwitchProfilesCount: description: |- Number of switch profiles that are part of this cluster profile. type: integer format: int64 readOnly: true x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true SwitchProfiles: # A Relationship to MO fabric.SwitchProfile description: An array of relationships to fabricSwitchProfile resources. type: array items: $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' nullable: true fabric.SwitchClusterProfile.List: title: List of 'fabric.SwitchClusterProfile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.SwitchClusterProfile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.SwitchClusterProfile' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.SwitchClusterProfile' nullable: true fabric.SwitchProfile.Response: description: |- The response body of a HTTP GET request for the 'fabric.SwitchProfile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.SwitchProfile' resources. x-one-of-name: fabric.SwitchProfile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.SwitchProfile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.SwitchProfile.Relationship: description: A relationship to the 'fabric.SwitchProfile' resource, or the expanded 'fabric.SwitchProfile' resource, or the 'null' value. x-one-of-name: fabric.SwitchProfile.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fabric.SwitchProfile' fabric.SwitchProfile: title: Switch Profile description: |- This specifies configuration policies for a managed network switch. x-allOf-name: fabric.SwitchProfile allOf: - # This 'fabric.SwitchProfile' class inherits all properties from its parent class policy.AbstractConfigProfile. $ref: '#/components/schemas/policy.AbstractConfigProfile' - # The definition of all the properties specified in this 'fabric.SwitchProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.SwitchProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.SwitchProfile' ObjectType: enum: - 'fabric.SwitchProfile' ConfigChanges: description: |- This lists the pending configuration changes at the summary level. Detailed changes are saved in configChangeDetails as a separate object. $ref: '#/components/schemas/policy.ConfigChange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AssignedSwitch: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. AssociatedSwitch: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ConfigChangeDetails: # A Relationship to MO fabric.ConfigChangeDetail description: An array of relationships to fabricConfigChangeDetail resources. type: array items: $ref: '#/components/schemas/fabric.ConfigChangeDetail.Relationship' nullable: true readOnly: true ConfigResult: # A Relationship to MO fabric.ConfigResult $ref: '#/components/schemas/fabric.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningWorkflows: # A Relationship to MO workflow.WorkflowInfo description: An array of relationships to workflowWorkflowInfo resources. type: array items: $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' nullable: true readOnly: true SwitchClusterProfile: # A Relationship to MO fabric.SwitchClusterProfile $ref: '#/components/schemas/fabric.SwitchClusterProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricSwitchClusterProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.SwitchProfile.List: title: List of 'fabric.SwitchProfile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.SwitchProfile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.SwitchProfile' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.SwitchProfile' nullable: true fabric.SystemQosPolicy.Response: description: |- The response body of a HTTP GET request for the 'fabric.SystemQosPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.SystemQosPolicy' resources. x-one-of-name: fabric.SystemQosPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.SystemQosPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.SystemQosPolicy: title: System QoS description: |- Configuration object sent by user to setup Quality of Service (QoS) for this switch. x-allOf-name: fabric.SystemQosPolicy allOf: - # This 'fabric.SystemQosPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'fabric.SystemQosPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.SystemQosPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.SystemQosPolicy' ObjectType: enum: - 'fabric.SystemQosPolicy' Classes: type: array items: description: |- Collection of QoS Classes to be configured. $ref: '#/components/schemas/fabric.QosClass' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO fabric.SwitchProfile description: An array of relationships to fabricSwitchProfile resources. type: array items: $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' nullable: true fabric.SystemQosPolicy.List: title: List of 'fabric.SystemQosPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.SystemQosPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.SystemQosPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.SystemQosPolicy' nullable: true fabric.UplinkPcRole.Response: description: |- The response body of a HTTP GET request for the 'fabric.UplinkPcRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.UplinkPcRole' resources. x-one-of-name: fabric.UplinkPcRole.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.UplinkPcRole.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.UplinkPcRole: title: Fabric:Uplink Pc Role description: |- Object sent by user to configure a ethernet uplink port-channel on the collection of ports. x-allOf-name: fabric.UplinkPcRole allOf: - # This 'fabric.UplinkPcRole' class inherits all properties from its parent class fabric.PortChannelRole. $ref: '#/components/schemas/fabric.PortChannelRole' - # The definition of all the properties specified in this 'fabric.UplinkPcRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.UplinkPcRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.UplinkPcRole' ObjectType: enum: - 'fabric.UplinkPcRole' AdminSpeed: description: |- Admin configured speed for the port. * `Auto` - Admin configurable speed AUTO ( default ). * `1Gbps` - Admin configurable speed 1Gbps. * `10Gbps` - Admin configurable speed 10Gbps. * `25Gbps` - Admin configurable speed 25Gbps. * `40Gbps` - Admin configurable speed 40Gbps. * `100Gbps` - Admin configurable speed 100Gbps. type: string enum: - 'Auto' - '1Gbps' - '10Gbps' - '25Gbps' - '40Gbps' - '100Gbps' default: Auto x-omitempty: true UdldAdminState: description: |- Admin configured state for UDLD for this port. * `Disabled` - Admin configured Disabled State. * `Enabled` - Admin configured Enabled State. type: string enum: - 'Disabled' - 'Enabled' default: Disabled x-omitempty: true fabric.UplinkPcRole.List: title: List of 'fabric.UplinkPcRole' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.UplinkPcRole' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.UplinkPcRole' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.UplinkPcRole' nullable: true fabric.UplinkRole.Response: description: |- The response body of a HTTP GET request for the 'fabric.UplinkRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.UplinkRole' resources. x-one-of-name: fabric.UplinkRole.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.UplinkRole.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.UplinkRole: title: Fabric:Uplink Role description: |- Configuration object sent by user to create a uplink port. x-allOf-name: fabric.UplinkRole allOf: - # This 'fabric.UplinkRole' class inherits all properties from its parent class fabric.PortRole. $ref: '#/components/schemas/fabric.PortRole' - # The definition of all the properties specified in this 'fabric.UplinkRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.UplinkRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.UplinkRole' ObjectType: enum: - 'fabric.UplinkRole' AdminSpeed: description: |- Admin configured speed for the port. * `Auto` - Admin configurable speed AUTO ( default ). * `1Gbps` - Admin configurable speed 1Gbps. * `10Gbps` - Admin configurable speed 10Gbps. * `25Gbps` - Admin configurable speed 25Gbps. * `40Gbps` - Admin configurable speed 40Gbps. * `100Gbps` - Admin configurable speed 100Gbps. type: string enum: - 'Auto' - '1Gbps' - '10Gbps' - '25Gbps' - '40Gbps' - '100Gbps' default: Auto x-omitempty: true Fec: description: |- Forward error correction configuration for the port. * `Auto` - Forward error correction option 'Auto'. * `Cl91` - Forward error correction option 'cl91'. * `Cl74` - Forward error correction option 'cl74'. type: string enum: - 'Auto' - 'Cl91' - 'Cl74' default: Auto x-omitempty: true UdldAdminState: description: |- Admin configured state for UDLD for this port. * `Disabled` - Admin configured Disabled State. * `Enabled` - Admin configured Enabled State. type: string enum: - 'Disabled' - 'Enabled' default: Disabled x-omitempty: true fabric.UplinkRole.List: title: List of 'fabric.UplinkRole' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.UplinkRole' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.UplinkRole' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.UplinkRole' nullable: true fabric.Vlan.Response: description: |- The response body of a HTTP GET request for the 'fabric.Vlan' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.Vlan' resources. x-one-of-name: fabric.Vlan.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.Vlan.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.Vlan: title: Fabric:Vlan description: |- Configuration object for Virtual LAN. x-allOf-name: fabric.Vlan allOf: - # This 'fabric.Vlan' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.Vlan' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.Vlan', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.Vlan' ObjectType: enum: - 'fabric.Vlan' IsNative: description: |- Used to define whether this VLAN is to be classified as 'native' for traffic in this FI. type: boolean x-omitempty: true Name: description: |- The 'name' used to identify this VLAN. type: string x-omitempty: true VlanId: description: |- The identifier for this Virtual LAN. type: integer format: int64 minimum: 1 maximum: 4093 x-omitempty: true EthNetworkPolicy: # A Relationship to MO fabric.EthNetworkPolicy $ref: '#/components/schemas/fabric.EthNetworkPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricEthNetworkPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.Vlan.List: title: List of 'fabric.Vlan' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.Vlan' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.Vlan' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.Vlan' nullable: true fabric.VlanSettings: title: VLAN Settings description: |- VLAN configuration for the virtual interface. x-allOf-name: fabric.VlanSettings allOf: - # This 'fabric.VlanSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'fabric.VlanSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.VlanSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.VlanSettings' ObjectType: enum: - 'fabric.VlanSettings' AllowedVlans: description: |- Allowed VLAN IDs of the virtual interface. type: string pattern: "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$" x-omitempty: true NativeVlan: description: |- Native VLAN ID of the virtual interface or the corresponding vethernet on the peer Fabric Interconnect to which the virtual interface is connected. Setting the ID to 0 will not associate any native VLAN to the traffic on the virtual interface. type: integer format: int64 minimum: 0 maximum: 4094 x-omitempty: true fabric.Vsan.Response: description: |- The response body of a HTTP GET request for the 'fabric.Vsan' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fabric.Vsan' resources. x-one-of-name: fabric.Vsan.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fabric.Vsan.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fabric.Vsan: title: Fabric:Vsan description: |- Configuration object sent by user to create VSAN configurations. x-allOf-name: fabric.Vsan allOf: - # This 'fabric.Vsan' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fabric.Vsan' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fabric.Vsan', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fabric.Vsan' ObjectType: enum: - 'fabric.Vsan' DefaultZoning: description: |- Enables or Disables the default zoning state. * `Enabled` - Admin configured Enabled State. * `Disabled` - Admin configured Disabled State. type: string enum: - 'Enabled' - 'Disabled' default: Enabled x-omitempty: true FcZoneSharingMode: description: |- Logical grouping mode for fc ports. type: string x-omitempty: true FcoeVlan: description: |- FCOE Vlan associated to the VSAN configuration. type: integer format: int64 x-omitempty: true Name: description: |- User given name for the VSAN configuration. type: string x-omitempty: true VsanId: description: |- Virtual San Identifier in the switch. type: integer format: int64 minimum: 1 maximum: 4093 x-omitempty: true FcNetworkPolicy: # A Relationship to MO fabric.FcNetworkPolicy $ref: '#/components/schemas/fabric.FcNetworkPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricFcNetworkPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. fabric.Vsan.List: title: List of 'fabric.Vsan' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fabric.Vsan' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fabric.Vsan' resources matching the request. type: array items: $ref: '#/components/schemas/fabric.Vsan' nullable: true fault.Instance.Response: description: |- The response body of a HTTP GET request for the 'fault.Instance' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fault.Instance' resources. x-one-of-name: fault.Instance.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fault.Instance.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fault.Instance: title: Fault:Instance description: |- An endpoint anomaly is represented by this object. x-allOf-name: fault.Instance allOf: - # This 'fault.Instance' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'fault.Instance' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fault.Instance', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fault.Instance' ObjectType: enum: - 'fault.Instance' Acknowledged: description: |- The user acknowledgement state of the fault. type: string readOnly: true x-omitempty: true AffectedDn: description: |- The Distinguished Name of the Managed object which was affected. type: string readOnly: true x-omitempty: true AffectedMoId: description: |- Managed object Id which was affected. type: string readOnly: true x-omitempty: true AffectedMoType: description: |- Managed object type which was affected. type: string readOnly: true x-omitempty: true AncestorMoId: description: |- Object Id of the parent of the Managed object which was affected. type: string readOnly: true x-omitempty: true AncestorMoType: description: |- Object type of the parent of the Managed object which was affected. type: string readOnly: true x-omitempty: true Code: description: |- Numerical fault code of the fault found. type: string readOnly: true x-omitempty: true CreationTime: description: |- The time of creation of the fault instance. type: string readOnly: true x-omitempty: true Description: description: |- Detailed message of the fault. type: string readOnly: true x-omitempty: true LastTransitionTime: description: |- Last transition time of the fault. type: string readOnly: true x-omitempty: true NumOccurrences: description: |- The number of times this fault has occured. type: integer format: int64 readOnly: true x-omitempty: true OriginalSeverity: description: |- Current Severity of the fault found. type: string readOnly: true x-omitempty: true PreviousSeverity: description: |- The Severity of the fault prior to user update. type: string readOnly: true x-omitempty: true Rule: description: |- The rule that is responsible for generation of the fault. type: string readOnly: true x-omitempty: true Severity: description: |- Severity of the fault found. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fault.Instance.List: title: List of 'fault.Instance' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fault.Instance' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fault.Instance' resources matching the request. type: array items: $ref: '#/components/schemas/fault.Instance' nullable: true fc.PhysicalPort.Response: description: |- The response body of a HTTP GET request for the 'fc.PhysicalPort' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fc.PhysicalPort' resources. x-one-of-name: fc.PhysicalPort.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fc.PhysicalPort.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fc.PhysicalPort.Relationship: description: A relationship to the 'fc.PhysicalPort' resource, or the expanded 'fc.PhysicalPort' resource, or the 'null' value. x-one-of-name: fc.PhysicalPort.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fc.PhysicalPort' fc.PhysicalPort: title: Fc:Physical Port description: |- Physical fibre channel port present on a FI. x-allOf-name: fc.PhysicalPort allOf: - # This 'fc.PhysicalPort' class inherits all properties from its parent class port.Physical. $ref: '#/components/schemas/port.Physical' - # The definition of all the properties specified in this 'fc.PhysicalPort' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fc.PhysicalPort', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fc.PhysicalPort' ObjectType: enum: - 'fc.PhysicalPort' AdminSpeed: description: |- Administrator configured Speed applied on the port. type: string readOnly: true x-omitempty: true AdminState: description: |- Administratively configured state (enabled/disabled) for this port. type: string readOnly: true x-omitempty: true B2bCredit: description: |- Buffer to Buffer credits of FC port. type: integer format: int64 readOnly: true x-omitempty: true MaxSpeed: description: |- Maximum Speed with which the port operates. type: string readOnly: true x-omitempty: true Mode: description: |- Mode information N_proxy, F or E associated to the Fibre Channel port. type: string readOnly: true x-omitempty: true OperSpeed: description: |- Operational Speed with which the port operates. type: string readOnly: true x-omitempty: true PeerDn: description: |- PeerDn for fibre channel physical port. type: string readOnly: true x-omitempty: true PortChannelId: description: |- Port channel id of FC port channel created on FI switch. type: integer format: int64 readOnly: true x-omitempty: true TransceiverType: description: |- Transceiver type of a Fibre Channel port. type: string readOnly: true x-omitempty: true Vsan: description: |- Virtual San that is associated to the port. type: integer format: int64 readOnly: true x-omitempty: true Wwn: description: |- World Wide Name of a Fibre Channel port. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortGroup: # A Relationship to MO port.Group $ref: '#/components/schemas/port.Group.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a portGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortSubGroup: # A Relationship to MO port.SubGroup $ref: '#/components/schemas/port.SubGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a portSubGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fc.PhysicalPort.List: title: List of 'fc.PhysicalPort' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fc.PhysicalPort' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fc.PhysicalPort' resources matching the request. type: array items: $ref: '#/components/schemas/fc.PhysicalPort' nullable: true fc.PortChannel.Response: description: |- The response body of a HTTP GET request for the 'fc.PortChannel' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fc.PortChannel' resources. x-one-of-name: fc.PortChannel.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fc.PortChannel.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fc.PortChannel.Relationship: description: A relationship to the 'fc.PortChannel' resource, or the expanded 'fc.PortChannel' resource, or the 'null' value. x-one-of-name: fc.PortChannel.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fc.PortChannel' fc.PortChannel: title: Fc:Port Channel description: |- Model contains the details of the ethernet port-channels configured on the FI. x-allOf-name: fc.PortChannel allOf: - # This 'fc.PortChannel' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'fc.PortChannel' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fc.PortChannel', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fc.PortChannel' ObjectType: enum: - 'fc.PortChannel' AdminSpeed: description: |- Administrator configured Speed applied on the port channel. type: string x-omitempty: true AdminState: description: |- Administratively configured state (enabled/disabled) for this portchannel. type: string readOnly: true x-omitempty: true Mode: description: |- Mode information N_proxy, F or E associated to the Fibre Channel portchannel. type: string x-omitempty: true OperSpeed: description: |- Operational speed of this port-channel. type: string x-omitempty: true OperState: description: |- Operational state of this port-channel. type: string x-omitempty: true OperStateQual: description: |- Reason for this port-channel's Operational state. type: string x-omitempty: true PortChannelId: description: |- Unique identifier for this port-channel on the FI. type: integer format: int64 x-omitempty: true Role: description: |- This port-channel's configured role (fcUplink, fcStorage, etc.). type: string x-omitempty: true SwitchId: description: |- Switch Identifier that is local to a cluster. type: string x-omitempty: true Vsan: description: |- Virtual San that is associated to the port-channel. type: integer format: int64 x-omitempty: true EquipmentSwitchCard: # A Relationship to MO equipment.SwitchCard $ref: '#/components/schemas/equipment.SwitchCard.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSwitchCard resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fc.PortChannel.List: title: List of 'fc.PortChannel' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fc.PortChannel' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fc.PortChannel' resources matching the request. type: array items: $ref: '#/components/schemas/fc.PortChannel' nullable: true fcpool.Block: title: Fcpool:Block description: |- Block of WWN identifiers. x-allOf-name: fcpool.Block allOf: - # This 'fcpool.Block' class inherits all properties from its parent class pool.AbstractBlockType. $ref: '#/components/schemas/pool.AbstractBlockType' - # The definition of all the properties specified in this 'fcpool.Block' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fcpool.Block', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fcpool.Block' ObjectType: enum: - 'fcpool.Block' From: description: |- Starting WWN identifier of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. Allowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF. To ensure uniqueness of WWN's in the SAN fabric, you are strongly encouraged to use the following WWN prefix; 20:00:00:25:B5:xx:xx:xx. type: string pattern: "((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2}))" x-omitempty: true To: description: |- Ending WWN identifier of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. type: string pattern: "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2}))" x-omitempty: true fcpool.FcBlock.Response: description: |- The response body of a HTTP GET request for the 'fcpool.FcBlock' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fcpool.FcBlock' resources. x-one-of-name: fcpool.FcBlock.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fcpool.FcBlock.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fcpool.FcBlock.Relationship: description: A relationship to the 'fcpool.FcBlock' resource, or the expanded 'fcpool.FcBlock' resource, or the 'null' value. x-one-of-name: fcpool.FcBlock.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fcpool.FcBlock' fcpool.FcBlock: title: Fcpool:Fc Block description: |- A block of contiguous WWN addresses that are part of a pool. x-allOf-name: fcpool.FcBlock allOf: - # This 'fcpool.FcBlock' class inherits all properties from its parent class pool.AbstractBlock. $ref: '#/components/schemas/pool.AbstractBlock' - # The definition of all the properties specified in this 'fcpool.FcBlock' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fcpool.FcBlock', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fcpool.FcBlock' ObjectType: enum: - 'fcpool.FcBlock' IdBlock: description: |- A block of WWN addresses. $ref: '#/components/schemas/fcpool.Block' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Pool: # A Relationship to MO fcpool.Pool $ref: '#/components/schemas/fcpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fcpool.FcBlock.List: title: List of 'fcpool.FcBlock' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fcpool.FcBlock' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fcpool.FcBlock' resources matching the request. type: array items: $ref: '#/components/schemas/fcpool.FcBlock' nullable: true fcpool.Lease.Response: description: |- The response body of a HTTP GET request for the 'fcpool.Lease' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fcpool.Lease' resources. x-one-of-name: fcpool.Lease.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fcpool.Lease.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fcpool.Lease.Relationship: description: A relationship to the 'fcpool.Lease' resource, or the expanded 'fcpool.Lease' resource, or the 'null' value. x-one-of-name: fcpool.Lease.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fcpool.Lease' fcpool.Lease: title: Fcpool:Lease description: |- Lease represents a single WWN ID that is part of the universe, allocated either from a pool or through static assignment. x-allOf-name: fcpool.Lease allOf: - # This 'fcpool.Lease' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fcpool.Lease' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fcpool.Lease', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fcpool.Lease' ObjectType: enum: - 'fcpool.Lease' PoolPurpose: description: |- Purpose of this WWN pool. type: string readOnly: true x-omitempty: true WwnId: description: |- WWN ID allocated for pool based allocation. type: string pattern: "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2}))" x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. Pool: # A Relationship to MO fcpool.Pool $ref: '#/components/schemas/fcpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true PoolMember: # A Relationship to MO fcpool.PoolMember $ref: '#/components/schemas/fcpool.PoolMember.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolPoolMember resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Universe: # A Relationship to MO fcpool.Universe $ref: '#/components/schemas/fcpool.Universe.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolUniverse resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fcpool.Lease.List: title: List of 'fcpool.Lease' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fcpool.Lease' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fcpool.Lease' resources matching the request. type: array items: $ref: '#/components/schemas/fcpool.Lease' nullable: true fcpool.Pool.Response: description: |- The response body of a HTTP GET request for the 'fcpool.Pool' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fcpool.Pool' resources. x-one-of-name: fcpool.Pool.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fcpool.Pool.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fcpool.Pool.Relationship: description: A relationship to the 'fcpool.Pool' resource, or the expanded 'fcpool.Pool' resource, or the 'null' value. x-one-of-name: fcpool.Pool.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fcpool.Pool' fcpool.Pool: title: Fcpool:Pool description: |- Pool represents a collection of WWN addresses that can be allocated to VHBAs of a server profile. x-allOf-name: fcpool.Pool allOf: - # This 'fcpool.Pool' class inherits all properties from its parent class pool.AbstractPool. $ref: '#/components/schemas/pool.AbstractPool' - # The definition of all the properties specified in this 'fcpool.Pool' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fcpool.Pool', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fcpool.Pool' ObjectType: enum: - 'fcpool.Pool' IdBlocks: type: array items: description: |- Collection of WWN blocks. $ref: '#/components/schemas/fcpool.Block' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 PoolPurpose: description: |- Purpose of this WWN pool. type: string x-omitempty: true BlockHeads: # A Relationship to MO fcpool.FcBlock description: An array of relationships to fcpoolFcBlock resources. type: array items: $ref: '#/components/schemas/fcpool.FcBlock.Relationship' nullable: true readOnly: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true fcpool.Pool.List: title: List of 'fcpool.Pool' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fcpool.Pool' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fcpool.Pool' resources matching the request. type: array items: $ref: '#/components/schemas/fcpool.Pool' nullable: true fcpool.PoolMember.Response: description: |- The response body of a HTTP GET request for the 'fcpool.PoolMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fcpool.PoolMember' resources. x-one-of-name: fcpool.PoolMember.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fcpool.PoolMember.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fcpool.PoolMember.Relationship: description: A relationship to the 'fcpool.PoolMember' resource, or the expanded 'fcpool.PoolMember' resource, or the 'null' value. x-one-of-name: fcpool.PoolMember.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fcpool.PoolMember' fcpool.PoolMember: title: Fcpool:Pool Member description: |- PoolMember represents a single WWN ID that is part of a pool. x-allOf-name: fcpool.PoolMember allOf: - # This 'fcpool.PoolMember' class inherits all properties from its parent class pool.AbstractPoolMember. $ref: '#/components/schemas/pool.AbstractPoolMember' - # The definition of all the properties specified in this 'fcpool.PoolMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fcpool.PoolMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fcpool.PoolMember' ObjectType: enum: - 'fcpool.PoolMember' WwnId: description: |- WWN ID of this pool member. type: string pattern: "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2}))" x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. BlockHead: # A Relationship to MO fcpool.FcBlock $ref: '#/components/schemas/fcpool.FcBlock.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolFcBlock resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Peer: # A Relationship to MO fcpool.Lease $ref: '#/components/schemas/fcpool.Lease.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolLease resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Pool: # A Relationship to MO fcpool.Pool $ref: '#/components/schemas/fcpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fcpool.PoolMember.List: title: List of 'fcpool.PoolMember' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fcpool.PoolMember' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fcpool.PoolMember' resources matching the request. type: array items: $ref: '#/components/schemas/fcpool.PoolMember' nullable: true fcpool.Universe.Response: description: |- The response body of a HTTP GET request for the 'fcpool.Universe' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'fcpool.Universe' resources. x-one-of-name: fcpool.Universe.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/fcpool.Universe.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType fcpool.Universe.Relationship: description: A relationship to the 'fcpool.Universe' resource, or the expanded 'fcpool.Universe' resource, or the 'null' value. x-one-of-name: fcpool.Universe.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/fcpool.Universe' fcpool.Universe: title: Fcpool:Universe description: |- Universe represents a book keeping container to keep track of all IDs for a given account and pool type. x-allOf-name: fcpool.Universe allOf: - # This 'fcpool.Universe' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'fcpool.Universe' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'fcpool.Universe', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'fcpool.Universe' ObjectType: enum: - 'fcpool.Universe' Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true fcpool.Universe.List: title: List of 'fcpool.Universe' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'fcpool.Universe' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'fcpool.Universe' resources matching the request. type: array items: $ref: '#/components/schemas/fcpool.Universe' nullable: true feedback.FeedbackData: title: Feedback:Feedback Data description: |- Feedback data that collected on the UI from user. x-allOf-name: feedback.FeedbackData allOf: - # This 'feedback.FeedbackData' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'feedback.FeedbackData' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'feedback.FeedbackData', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'feedback.FeedbackData' ObjectType: enum: - 'feedback.FeedbackData' AccountName: description: |- Account name of the feedback sender. Copied in order to be persisted 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 Comment: description: |- Text of the feedback as provided by the user, if it is a bug or a comment. type: string maxLength: 1500 x-omitempty: true Email: description: |- User's email address details. type: string x-omitempty: true Evaluation: description: |- Evalation rating as provided by the user to capture user sentiment regarding the issue. * `Excellent` - Option that specifies user's excelent evaluation. * `Poor` - Option that specifies user's poor evaluation. * `Fair` - Option that specifies user's fair evaluation. * `Good` - Option that specifies user's good evaluation. type: string enum: - 'Excellent' - 'Poor' - 'Fair' - 'Good' default: Excellent x-omitempty: true FollowUp: description: |- If a user is open for follow-up or not. type: boolean x-omitempty: true TraceIds: description: |- Bunch of last traceId for reproducing user last activity. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true Type: description: |- Type of the feedback from user. * `Evaluation` - User's feedback classified as an evaluation. * `Bug` - User's feedback classified as a bug. type: string enum: - 'Evaluation' - 'Bug' default: Evaluation x-omitempty: true feedback.FeedbackPost: title: Feedback:Feedback Post description: |- Initial feedback submitted by the user from UI. x-allOf-name: feedback.FeedbackPost allOf: - # This 'feedback.FeedbackPost' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'feedback.FeedbackPost' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'feedback.FeedbackPost', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'feedback.FeedbackPost' ObjectType: enum: - 'feedback.FeedbackPost' FeedbackData: description: |- Feedback collected from the user and latest activity. $ref: '#/components/schemas/feedback.FeedbackData' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true firmware.BaseDistributable: title: Firmware:Base Distributable description: |- An image distributed by Cisco. x-allOf-name: firmware.BaseDistributable allOf: - # This 'firmware.BaseDistributable' class inherits all properties from its parent class softwarerepository.File. $ref: '#/components/schemas/softwarerepository.File' - # The definition of all the properties specified in this 'firmware.BaseDistributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.BaseDistributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: BundleType: description: |- The bundle type of the image, as published on cisco.com. type: string readOnly: true x-omitempty: true ComponentMeta: type: array items: description: |- The information about the catalog component. $ref: '#/components/schemas/firmware.ComponentMeta' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Guid: description: |- The unique identifier for an image in a Cisco repository. type: string readOnly: true x-omitempty: true Mdfid: description: |- The mdfid of the image provided by cisco.com. type: string x-omitempty: true Model: description: |- The endpoint model for which this firmware image is applicable. type: string x-omitempty: true PlatformType: description: |- The platform type of the image. type: string readOnly: true x-omitempty: true RecommendedBuild: description: |- The build which is recommended by Cisco. type: string x-omitempty: true ReleaseNotesUrl: description: |- The url for the release notes of this image. type: string x-omitempty: true SoftwareTypeId: description: |- The software type id provided by cisco.com. type: string readOnly: true x-omitempty: true SupportedModels: type: array items: description: |- The server models for which this image is applicable. type: string x-omitempty: true minItems: 1 Vendor: description: |- The vendor or publisher of this file. type: string x-omitempty: true DistributableMetas: # A Relationship to MO firmware.DistributableMeta description: An array of relationships to firmwareDistributableMeta resources. type: array items: $ref: '#/components/schemas/firmware.DistributableMeta.Relationship' nullable: true Release: # A Relationship to MO softwarerepository.Release $ref: '#/components/schemas/softwarerepository.Release.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryRelease resource. When the $expand query parameter is specified, the referenced resource is returned inline. firmware.BaseImpact: title: Firmware:Base Impact description: |- The abstract entity depicting impact on the endpoint during the upgrade operation. x-allOf-name: firmware.BaseImpact allOf: - # This 'firmware.BaseImpact' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.BaseImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.BaseImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ComputationError: description: |- Details for the error that occurred during the reboot validation analysis. type: string x-omitempty: true ComputationStatusDetail: description: |- The computation status of the estimate operation for a component. * `Inprogress` - Upgrade impact calculation is in progress. * `Completed` - Upgrade impact calculation is completed. * `Unavailable` - Upgrade impact is not available since the image is not present in the Fabric Interconnect. * `Failed` - Upgrade impact is not available due to an unknown error. type: string enum: - 'Inprogress' - 'Completed' - 'Unavailable' - 'Failed' default: Inprogress x-omitempty: true DomainName: description: |- The endpoint type or name. type: string x-omitempty: true EndPoint: description: |- A reference to a REST resource, uniquely identified by object type and MOID. type: string x-omitempty: true FirmwareVersion: description: |- The current firmware version of the component. type: string x-omitempty: true ImpactType: description: |- The impact type of the endpoint, whether a reboot is required or not. * `NoReboot` - A reboot is not required for the endpoint after upgrade. * `Reboot` - A reboot is required to the endpoint after upgrade. type: string enum: - 'NoReboot' - 'Reboot' default: NoReboot x-omitempty: true Model: description: |- The model details of the component. type: string x-omitempty: true TargetFirmwareVersion: description: |- The target firmware version of the component. type: string x-omitempty: true VersionImpact: description: |- The change of version impact for the endpoint. * `None` - No change in version for the component. * `Upgrade` - The component will be upgraded. * `Downgrade` - The component will be downgraded. type: string enum: - 'None' - 'Upgrade' - 'Downgrade' default: None x-omitempty: true firmware.BiosDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.BiosDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.BiosDescriptor' resources. x-one-of-name: firmware.BiosDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.BiosDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.BiosDescriptor: title: Firmware:Bios Descriptor description: |- Descriptor to uniquely identify a BIOS. x-allOf-name: firmware.BiosDescriptor allOf: - # This 'firmware.BiosDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.BiosDescriptor.List: title: List of 'firmware.BiosDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.BiosDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.BiosDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.BiosDescriptor' nullable: true firmware.BoardControllerDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.BoardControllerDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.BoardControllerDescriptor' resources. x-one-of-name: firmware.BoardControllerDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.BoardControllerDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.BoardControllerDescriptor: title: Firmware:Board Controller Descriptor description: |- Descriptor to uniquely identify a board controller. x-allOf-name: firmware.BoardControllerDescriptor allOf: - # This 'firmware.BoardControllerDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.BoardControllerDescriptor.List: title: List of 'firmware.BoardControllerDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.BoardControllerDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.BoardControllerDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.BoardControllerDescriptor' nullable: true firmware.ChassisUpgrade.Response: description: |- The response body of a HTTP GET request for the 'firmware.ChassisUpgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.ChassisUpgrade' resources. x-one-of-name: firmware.ChassisUpgrade.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.ChassisUpgrade.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.ChassisUpgrade: title: Firmware:Chassis Upgrade description: |- Firmware upgrade operation for chassis that downloads the image located at Cisco/appliance/user provided HTTP repository or uses the image from a network share and upgrade. Direct download is used for upgrade that uses the image from a Cisco repository or an appliance repository. Network share is used for upgrade that use the image from a network share from your data center. x-allOf-name: firmware.ChassisUpgrade allOf: - # This 'firmware.ChassisUpgrade' class inherits all properties from its parent class firmware.UpgradeBase. $ref: '#/components/schemas/firmware.UpgradeBase' - # The definition of all the properties specified in this 'firmware.ChassisUpgrade' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.ChassisUpgrade', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.ChassisUpgrade' ObjectType: enum: - 'firmware.ChassisUpgrade' ExcludeComponentList: type: array items: description: |- The components to exclude from the chassis firmware upgrade. * `none` - If no component is selected for exclusion. * `local-disk` - Component to be excluded is local disk. type: string enum: - 'none' - 'local-disk' default: none x-omitempty: true Chassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true firmware.ChassisUpgrade.List: title: List of 'firmware.ChassisUpgrade' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.ChassisUpgrade' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.ChassisUpgrade' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.ChassisUpgrade' nullable: true firmware.ChassisUpgradeImpact: title: Firmware:Chassis Upgrade Impact description: |- Impact of the chassis endpoint during the upgrade operation. x-allOf-name: firmware.ChassisUpgradeImpact allOf: - # This 'firmware.ChassisUpgradeImpact' class inherits all properties from its parent class firmware.BaseImpact. $ref: '#/components/schemas/firmware.BaseImpact' - # The definition of all the properties specified in this 'firmware.ChassisUpgradeImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.ChassisUpgradeImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.ChassisUpgradeImpact' ObjectType: enum: - 'firmware.ChassisUpgradeImpact' ImpactDetail: type: array items: description: |- List of components that will be impacted during the upgrade. $ref: '#/components/schemas/firmware.ComponentImpact' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Name: description: |- Name of the chassis that will be affected by the upgrade. type: string x-omitempty: true UserLabel: description: |- Details for the chassis that will be impacted by the upgrade. type: string x-omitempty: true firmware.CifsServer: title: Firmware:Cifs Server description: |- An external file repository accessible through the CIFS protocol. x-allOf-name: firmware.CifsServer allOf: - # This 'firmware.CifsServer' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.CifsServer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.CifsServer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.CifsServer' ObjectType: enum: - 'firmware.CifsServer' FileLocation: description: |- The location to the image file. The accepted format is IP-or-hostname/folder1/folder2/.../imageFile. type: string x-omitempty: true MountOptions: description: |- Mount option (Authentication Protocol) as configured on the CIFS Server. Example:ntlmv2. * `none` - The default authentication protocol is decided by the endpoint. * `ntlm` - The external CIFS server is configured with ntlm as the authentication protocol. * `ntlmi` - Mount options of CIFS file server is ntlmi. * `ntlmv2` - Mount options of CIFS file server is ntlmv2. * `ntlmv2i` - Mount options of CIFS file server is ntlmv2i. * `ntlmssp` - Mount options of CIFS file server is ntlmssp. * `ntlmsspi` - Mount options of CIFS file server is ntlmsspi. type: string enum: - 'none' - 'ntlm' - 'ntlmi' - 'ntlmv2' - 'ntlmv2i' - 'ntlmssp' - 'ntlmsspi' default: none x-omitempty: true RemoteFile: description: |- Filename of the image in the remote share location. Example:ucs-c220m5-huu-3.1.2c.iso. type: string readOnly: true x-omitempty: true RemoteIp: description: |- CIFS Server Hostname or IP Address. For example:CIFS-server-hostname or 10.10.8.7. The remote share server should have network connectivity with the CIMC of the selected devices for a successful upgrade. type: string readOnly: true x-omitempty: true RemoteShare: description: |- Directory where the image is stored. Example:share/subfolder. type: string readOnly: true x-omitempty: true firmware.CimcDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.CimcDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.CimcDescriptor' resources. x-one-of-name: firmware.CimcDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.CimcDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.CimcDescriptor: title: Firmware:Cimc Descriptor description: |- Descriptor to uniquely identify a Cisco IMC. x-allOf-name: firmware.CimcDescriptor allOf: - # This 'firmware.CimcDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.CimcDescriptor.List: title: List of 'firmware.CimcDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.CimcDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.CimcDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.CimcDescriptor' nullable: true firmware.ComponentDescriptor: title: Firmware:Component Descriptor description: |- Descriptor to uniquely identify each component. x-allOf-name: firmware.ComponentDescriptor allOf: - # This 'firmware.ComponentDescriptor' class inherits all properties from its parent class capability.HardwareDescriptor. $ref: '#/components/schemas/capability.HardwareDescriptor' - # The definition of all the properties specified in this 'firmware.ComponentDescriptor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.ComponentDescriptor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: BrandString: description: |- The brand string of the endpoint for which this capability information is applicable. type: string x-omitempty: true Label: description: |- The label type for the component. type: string x-omitempty: true Revision: description: |- The revision for the component. type: string x-omitempty: true firmware.ComponentImpact: title: Firmware:Component Impact description: |- Impact for the components such as CIMC, BIOS, and disk during the upgrade operation. x-allOf-name: firmware.ComponentImpact allOf: - # This 'firmware.ComponentImpact' class inherits all properties from its parent class firmware.BaseImpact. $ref: '#/components/schemas/firmware.BaseImpact' - # The definition of all the properties specified in this 'firmware.ComponentImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.ComponentImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.ComponentImpact' ObjectType: enum: - 'firmware.ComponentImpact' Component: description: |- Impact on the component after the upgrade. * `ALL` - This represents all the components. * `ALL,HDD` - This represents all the components plus the HDDs. * `None` - This represents none of the components. * `NXOS` - This represents NXOS components. * `IOM` - This represents IOM components. * `PSU` - This represents PSU components. * `CIMC` - This represents CIMC components. * `BIOS` - This represents BIOS components. * `PCIE` - This represents PCIE components. * `Drive` - This represents Storage components. * `DIMM` - This represents DIMM components. * `BoardController` - This represents Board Controller components. * `StorageController` - This represents Storage Controller components. * `HBA` - This represents HBA components. * `GPU` - This represents GPU components. * `SasExpander` - This represents SasExpander components. * `MSwitch` - This represents mSwitch components. * `CMC` - This represents CMC components. type: string enum: - 'ALL' - 'ALL,HDD' - 'None' - 'NXOS' - 'IOM' - 'PSU' - 'CIMC' - 'BIOS' - 'PCIE' - 'Drive' - 'DIMM' - 'BoardController' - 'StorageController' - 'HBA' - 'GPU' - 'SasExpander' - 'MSwitch' - 'CMC' default: ALL x-omitempty: true firmware.ComponentMeta: title: Firmware:Component Meta description: |- Contains the details for each component in the HSU bundle catalog. x-allOf-name: firmware.ComponentMeta allOf: - # This 'firmware.ComponentMeta' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.ComponentMeta' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.ComponentMeta', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.ComponentMeta' ObjectType: enum: - 'firmware.ComponentMeta' ComponentLabel: description: |- The name of the component in the compressed HSU bundle. type: string x-omitempty: true ComponentType: description: |- The type of component image within the distributable. * `ALL` - This represents all the components. * `ALL,HDD` - This represents all the components plus the HDDs. * `None` - This represents none of the components. * `NXOS` - This represents NXOS components. * `IOM` - This represents IOM components. * `PSU` - This represents PSU components. * `CIMC` - This represents CIMC components. * `BIOS` - This represents BIOS components. * `PCIE` - This represents PCIE components. * `Drive` - This represents Storage components. * `DIMM` - This represents DIMM components. * `BoardController` - This represents Board Controller components. * `StorageController` - This represents Storage Controller components. * `HBA` - This represents HBA components. * `GPU` - This represents GPU components. * `SasExpander` - This represents SasExpander components. * `MSwitch` - This represents mSwitch components. * `CMC` - This represents CMC components. type: string enum: - 'ALL' - 'ALL,HDD' - 'None' - 'NXOS' - 'IOM' - 'PSU' - 'CIMC' - 'BIOS' - 'PCIE' - 'Drive' - 'DIMM' - 'BoardController' - 'StorageController' - 'HBA' - 'GPU' - 'SasExpander' - 'MSwitch' - 'CMC' default: ALL x-omitempty: true Description: description: |- This shows the description of component image within the distributable. type: string x-omitempty: true Disruption: description: |- The type of disruption on each component. For example, host reboot, automatic power cycle, and manual power cycle. * `None` - Indicates that the component did not receive a disruption request. * `HostReboot` - Indicates that the component received a host reboot request. * `EndpointReboot` - Indicates that the component received an end point reboot request. * `ManualPowerCycle` - Indicates that the component received a manual power cycle request. * `AutomaticPowerCycle` - Indicates that the component received an automatic power cycle request. type: string enum: - 'None' - 'HostReboot' - 'EndpointReboot' - 'ManualPowerCycle' - 'AutomaticPowerCycle' default: None x-omitempty: true IsOobSupported: description: |- If set, the component can be updated through out-of-band management, else, is updated through host service utility boot. type: boolean x-omitempty: true Model: description: |- The model of the component image in the distributable. type: string x-omitempty: true OobManageability: type: array items: description: |- The type of operation that can be done through out-of-band management. * `None` - The component cannot be updated through out-of-band management. The boot operation is done through the host service utility. * `Update` - The component can be updated through out-of-band management. * `Inventory` - The component inventory can be updated through out-of-band management. * `Activate` - The component can be activated through out-of-band management. * `Config` - The component can be configured through out-of-band management. type: string enum: - 'None' - 'Update' - 'Inventory' - 'Activate' - 'Config' default: None x-omitempty: true PackedVersion: description: |- The image version of components packaged in the distributable. type: string x-omitempty: true RedfishUrl: description: |- The redfish target for each component. type: string x-omitempty: true Vendor: description: |- The version of component image in the distributable. type: string x-omitempty: true firmware.DimmDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.DimmDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.DimmDescriptor' resources. x-one-of-name: firmware.DimmDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.DimmDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.DimmDescriptor: title: Firmware:Dimm Descriptor description: |- Descriptor to uniquely identify a DIMM. x-allOf-name: firmware.DimmDescriptor allOf: - # This 'firmware.DimmDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.DimmDescriptor.List: title: List of 'firmware.DimmDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.DimmDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.DimmDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.DimmDescriptor' nullable: true firmware.DirectDownload: title: Firmware:Direct Download description: |- A specification for downloading the image from Cisco or appliance repository or user provided HTTP file server that hosts the image for firmware upgrade. x-allOf-name: firmware.DirectDownload allOf: - # This 'firmware.DirectDownload' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.DirectDownload' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.DirectDownload', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.DirectDownload' ObjectType: enum: - 'firmware.DirectDownload' HttpServer: description: |- HTTP Server option when the image source is a local HTTPS server. $ref: '#/components/schemas/firmware.HttpServer' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ImageSource: description: |- Source type referring the image to be downloaded from CCO or from a local HTTPS server. * `cisco` - Image to be downloaded from Cisco software repository. * `localHttp` - Image to be downloaded from a https server. type: string enum: - 'cisco' - 'localHttp' default: cisco x-omitempty: true IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Password: description: |- Password as configured on the local https server. type: string writeOnly: true x-omitempty: true Upgradeoption: description: |- Option to control the upgrade, e.g., sd_upgrade_mount_only - download the image into sd and upgrade wait for the server on-next boot. * `sd_upgrade_mount_only` - Direct upgrade SD upgrade mount only. * `sd_download_only` - Direct upgrade SD download only. * `sd_upgrade_only` - Direct upgrade SD upgrade only. * `sd_upgrade_full` - Direct upgrade SD upgrade full. * `upgrade_full` - The upgrade downloads or mounts the image, and reboots immediately for an upgrade. * `upgrade_mount_only` - The upgrade downloads or mounts the image. The upgrade happens in next reboot. * `chassis_upgrade_full` - Direct upgrade chassis upgrade full. type: string enum: - 'sd_upgrade_mount_only' - 'sd_download_only' - 'sd_upgrade_only' - 'sd_upgrade_full' - 'upgrade_full' - 'upgrade_mount_only' - 'chassis_upgrade_full' default: sd_upgrade_mount_only x-omitempty: true Username: description: |- Username as configured on the local https server. type: string x-omitempty: true firmware.Distributable.Response: description: |- The response body of a HTTP GET request for the 'firmware.Distributable' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.Distributable' resources. x-one-of-name: firmware.Distributable.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.Distributable.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.Distributable.Relationship: description: A relationship to the 'firmware.Distributable' resource, or the expanded 'firmware.Distributable' resource, or the 'null' value. x-one-of-name: firmware.Distributable.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/firmware.Distributable' firmware.Distributable: title: Firmware:Distributable description: |- An image distributed by Cisco. x-allOf-name: firmware.Distributable allOf: - # This 'firmware.Distributable' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'firmware.Distributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.Distributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.Distributable' ObjectType: enum: - 'firmware.Distributable' FileLocation: description: |- The file location of the distributable. type: string x-omitempty: true ImageCategory: description: |- The category into which the distributable falls into according to the supported platform series. For e.g.; C-Series/B-Series/Infrastructure. type: string x-omitempty: true Origin: description: |- The source of the distributable. If it has been created by the user or system. * `System` - The distributable has been created by the System. * `User` - The distributable has been created by the User. type: string enum: - 'System' - 'User' default: System x-omitempty: true Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true firmware.Distributable.List: title: List of 'firmware.Distributable' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.Distributable' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.Distributable' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.Distributable' nullable: true firmware.DistributableMeta.Response: description: |- The response body of a HTTP GET request for the 'firmware.DistributableMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.DistributableMeta' resources. x-one-of-name: firmware.DistributableMeta.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.DistributableMeta.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.DistributableMeta.Relationship: description: A relationship to the 'firmware.DistributableMeta' resource, or the expanded 'firmware.DistributableMeta' resource, or the 'null' value. x-one-of-name: firmware.DistributableMeta.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/firmware.DistributableMeta' firmware.DistributableMeta: title: Firmware:Distributable Meta description: |- Meta information for various firmware images stored in the database. Gives information on the particular category for a product. x-allOf-name: firmware.DistributableMeta allOf: - # This 'firmware.DistributableMeta' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'firmware.DistributableMeta' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.DistributableMeta', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.DistributableMeta' ObjectType: enum: - 'firmware.DistributableMeta' BucketName: description: |- The S3 bucket name where the images are present, if source is external cloud store. type: string x-omitempty: true FileType: description: |- The type of distributable image, example huu, scu, driver, os. * `Distributable` - Stores firmware host utility images and fabric images. * `DriverDistributable` - Stores driver distributable images. * `ServerConfigurationUtilityDistributable` - Stores server configuration utility images. * `OperatingSystemFile` - Stores operating system iso images. * `HyperflexDistributable` - It stores HyperFlex images. type: string enum: - 'Distributable' - 'DriverDistributable' - 'ServerConfigurationUtilityDistributable' - 'OperatingSystemFile' - 'HyperflexDistributable' default: Distributable x-omitempty: true FromVersion: description: |- The version from which user can download images from amazon store, if source is external cloud store. type: string x-omitempty: true Mdfid: description: |- The mdfid of the image provided by cisco.com. type: string x-omitempty: true SoftwareTypeId: description: |- The software type id provided by cisco.com. type: string x-omitempty: true Source: description: |- The image can be downloaded from cisco.com or external cloud store. * `Cisco` - External repository hosted on cisco.com. * `IntersightCloud` - Repository hosted by the Intersight Cloud. * `LocalMachine` - The file is available on the local client machine. Used as an upload source type. * `NetworkShare` - External repository in the customer datacenter. This will typically be a file server. type: string enum: - 'Cisco' - 'IntersightCloud' - 'LocalMachine' - 'NetworkShare' default: Cisco x-omitempty: true SupportedModels: type: array items: description: |- Models which are supported by the corresponding mdfid. type: string x-omitempty: true ToVersion: description: |- The version till which user can download images from amazon store, if source is external cloud store. type: string x-omitempty: true firmware.DistributableMeta.List: title: List of 'firmware.DistributableMeta' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.DistributableMeta' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.DistributableMeta' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.DistributableMeta' nullable: true firmware.DriveDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.DriveDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.DriveDescriptor' resources. x-one-of-name: firmware.DriveDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.DriveDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.DriveDescriptor: title: Firmware:Drive Descriptor description: |- Descriptor to uniquely identify a Drive. x-allOf-name: firmware.DriveDescriptor allOf: - # This 'firmware.DriveDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.DriveDescriptor.List: title: List of 'firmware.DriveDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.DriveDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.DriveDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.DriveDescriptor' nullable: true firmware.DriverDistributable.Response: description: |- The response body of a HTTP GET request for the 'firmware.DriverDistributable' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.DriverDistributable' resources. x-one-of-name: firmware.DriverDistributable.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.DriverDistributable.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.DriverDistributable: title: Firmware:Driver Distributable description: |- A device driver image distributed by Cisco. x-allOf-name: firmware.DriverDistributable allOf: - # This 'firmware.DriverDistributable' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'firmware.DriverDistributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.DriverDistributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.DriverDistributable' ObjectType: enum: - 'firmware.DriverDistributable' Category: description: |- The device type on which the driver is installable. type: string x-omitempty: true Directory: description: |- Indicates in which directory path this driver will be added. type: string x-omitempty: true Osname: description: |- The operating system name to which this driver is compatible. type: string x-omitempty: true Osversion: description: |- OS Version. It is populated as part of the image import operation. type: string x-omitempty: true Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true firmware.DriverDistributable.List: title: List of 'firmware.DriverDistributable' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.DriverDistributable' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.DriverDistributable' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.DriverDistributable' nullable: true firmware.Eula.Response: description: |- The response body of a HTTP GET request for the 'firmware.Eula' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.Eula' resources. x-one-of-name: firmware.Eula.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.Eula.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.Eula: title: Firmware:Eula description: |- End User License Agreement (EULA) acceptance status for an account to access cisco.com and download software. x-allOf-name: firmware.Eula allOf: - # This 'firmware.Eula' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'firmware.Eula' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.Eula', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.Eula' ObjectType: enum: - 'firmware.Eula' Accepted: description: |- EULA acceptance status for the account. type: boolean readOnly: true x-omitempty: true Content: description: |- EULA acceptance form content provided by cisco.com. type: string readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true firmware.Eula.List: title: List of 'firmware.Eula' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.Eula' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.Eula' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.Eula' nullable: true firmware.FabricUpgradeImpact: title: Firmware:Fabric Upgrade Impact description: |- Impact for the Fabric Interconnect endpoint during the upgrade operation. x-allOf-name: firmware.FabricUpgradeImpact allOf: - # This 'firmware.FabricUpgradeImpact' class inherits all properties from its parent class firmware.BaseImpact. $ref: '#/components/schemas/firmware.BaseImpact' - # The definition of all the properties specified in this 'firmware.FabricUpgradeImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.FabricUpgradeImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.FabricUpgradeImpact' ObjectType: enum: - 'firmware.FabricUpgradeImpact' ImpactDetail: type: array items: description: |- List of components that will be affected during the upgrade. $ref: '#/components/schemas/firmware.ComponentImpact' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Serial: description: |- Details for the Fabric Interconnect that will be impacted by the upgrade. type: string x-omitempty: true firmware.FirmwareInventory: title: Firmware:Firmware Inventory description: |- Firmware inventory for server component. x-allOf-name: firmware.FirmwareInventory allOf: - # This 'firmware.FirmwareInventory' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.FirmwareInventory' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.FirmwareInventory', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.FirmwareInventory' ObjectType: enum: - 'firmware.FirmwareInventory' Category: description: |- Component category. For example, MRAID is under storage controller, CIMC is under management controller. type: string x-omitempty: true Label: description: |- The name of the component to reflect on UI. type: string x-omitempty: true Model: description: |- Model deatils of component. type: string x-omitempty: true UpdateUri: description: |- The redfish URI to get the firmware inventory of server components. type: string x-omitempty: true Vendor: description: |- The vendor of the component. type: string x-omitempty: true Version: description: |- The firmware running version on the component. type: string x-omitempty: true firmware.FirmwareSummary.Response: description: |- The response body of a HTTP GET request for the 'firmware.FirmwareSummary' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.FirmwareSummary' resources. x-one-of-name: firmware.FirmwareSummary.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.FirmwareSummary.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.FirmwareSummary: title: Firmware:Firmware Summary description: |- Update inventory that contains the details for the firmware running on each component in the compute.Physical object. x-allOf-name: firmware.FirmwareSummary allOf: - # This 'firmware.FirmwareSummary' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'firmware.FirmwareSummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.FirmwareSummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.FirmwareSummary' ObjectType: enum: - 'firmware.FirmwareSummary' BundleVersion: description: |- Version details at the bundle level for the each of server. type: string x-omitempty: true ComponentsFwInventory: type: array items: description: |- Collection of running firmware inventory for each component in rack/blade servers. $ref: '#/components/schemas/firmware.FirmwareInventory' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Server: # A Relationship to MO compute.Physical $ref: '#/components/schemas/compute.Physical.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computePhysical resource. When the $expand query parameter is specified, the referenced resource is returned inline. firmware.FirmwareSummary.List: title: List of 'firmware.FirmwareSummary' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.FirmwareSummary' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.FirmwareSummary' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.FirmwareSummary' nullable: true firmware.GpuDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.GpuDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.GpuDescriptor' resources. x-one-of-name: firmware.GpuDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.GpuDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.GpuDescriptor: title: Firmware:Gpu Descriptor description: |- Descriptor to uniquely identify a GPU component. x-allOf-name: firmware.GpuDescriptor allOf: - # This 'firmware.GpuDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.GpuDescriptor.List: title: List of 'firmware.GpuDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.GpuDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.GpuDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.GpuDescriptor' nullable: true firmware.HbaDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.HbaDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.HbaDescriptor' resources. x-one-of-name: firmware.HbaDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.HbaDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.HbaDescriptor: title: Firmware:Hba Descriptor description: |- Descriptor to uniquely identify a HBA component. x-allOf-name: firmware.HbaDescriptor allOf: - # This 'firmware.HbaDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.HbaDescriptor.List: title: List of 'firmware.HbaDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.HbaDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.HbaDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.HbaDescriptor' nullable: true firmware.HttpServer: title: Firmware:Http Server description: |- An external HTTP file server. x-allOf-name: firmware.HttpServer allOf: - # This 'firmware.HttpServer' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.HttpServer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.HttpServer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.HttpServer' ObjectType: enum: - 'firmware.HttpServer' LocationLink: description: |- HTTP/HTTPS link to the image. Accepted formats HTTP[s]://server-hostname/share/image or HTTP[s]://serverip/share/image. For a successful upgrade, the remote share server must have network connectivity with the CIMC of the selected devices. type: string x-omitempty: true MountOptions: description: |- Mount option as configured on the HTTP server. Empty if nothing is configured. type: string x-omitempty: true firmware.IomDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.IomDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.IomDescriptor' resources. x-one-of-name: firmware.IomDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.IomDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.IomDescriptor: title: Firmware:Iom Descriptor description: |- Descriptor to uniquely identify a IOM component. x-allOf-name: firmware.IomDescriptor allOf: - # This 'firmware.IomDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.IomDescriptor.List: title: List of 'firmware.IomDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.IomDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.IomDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.IomDescriptor' nullable: true firmware.MswitchDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.MswitchDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.MswitchDescriptor' resources. x-one-of-name: firmware.MswitchDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.MswitchDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.MswitchDescriptor: title: Firmware:Mswitch Descriptor description: |- Descriptor to uniquely identify a mSwitch component. x-allOf-name: firmware.MswitchDescriptor allOf: - # This 'firmware.MswitchDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.MswitchDescriptor.List: title: List of 'firmware.MswitchDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.MswitchDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.MswitchDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.MswitchDescriptor' nullable: true firmware.NetworkShare: title: Firmware:Network Share description: |- Firmware upgrade where the image is located in remote shared machine. x-allOf-name: firmware.NetworkShare allOf: - # This 'firmware.NetworkShare' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.NetworkShare' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.NetworkShare', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.NetworkShare' ObjectType: enum: - 'firmware.NetworkShare' CifsServer: description: |- CIFS file server option for network share upgrade. $ref: '#/components/schemas/firmware.CifsServer' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true HttpServer: description: |- HTTP (for WWW) file server option for network share upgrade. $ref: '#/components/schemas/firmware.HttpServer' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true MapType: description: |- File server protocols such as CIFS, NFS, WWW for HTTP (S) that hosts the image. * `nfs` - File server protocol used is NFS. * `cifs` - File server protocol used is CIFS. * `www` - File server protocol used is WWW. type: string enum: - 'nfs' - 'cifs' - 'www' default: nfs x-omitempty: true NfsServer: description: |- NFS file server option for network share upgrade. $ref: '#/components/schemas/firmware.NfsServer' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Password: description: |- Password as configured on the file server. type: string writeOnly: true x-omitempty: true Upgradeoption: description: |- Option to control the upgrade operation. Some examples, 1) nw_upgrade_mount_only - mount the image from a file server and run the upgrade on the next server boot and 2) nw_upgrade_full - mount the image and immediately run the upgrade. * `nw_upgrade_full` - Network upgrade option for full upgrade. * `nw_upgrade_mount_only` - Network upgrade mount only. type: string enum: - 'nw_upgrade_full' - 'nw_upgrade_mount_only' default: nw_upgrade_full x-omitempty: true Username: description: |- Username as configured on the file server. type: string x-omitempty: true firmware.NfsServer: title: Firmware:Nfs Server description: |- Network share file server. x-allOf-name: firmware.NfsServer allOf: - # This 'firmware.NfsServer' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'firmware.NfsServer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.NfsServer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.NfsServer' ObjectType: enum: - 'firmware.NfsServer' FileLocation: description: |- The location to the image file. The accepted format is IP-or-hostname/folder1/folder2/.../imageFile. type: string x-omitempty: true MountOptions: description: |- Mount option as configured on the NFS Server. For example:nolock. type: string x-omitempty: true RemoteFile: description: |- Filename of the image in the remote share location. For example:ucs-c220m5-huu-3.1.2c.iso. type: string readOnly: true x-omitempty: true RemoteIp: description: |- NFS Server Hostname or IP Address. For example:NFS-server-hostname or 10.10.8.7. The remote share server should have network connectivity with the CIMC of the selected devices for a successful upgrade. type: string readOnly: true x-omitempty: true RemoteShare: description: |- Directory where the image is stored. For example:/share/subfolder. type: string readOnly: true x-omitempty: true firmware.NxosDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.NxosDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.NxosDescriptor' resources. x-one-of-name: firmware.NxosDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.NxosDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.NxosDescriptor: title: Firmware:Nxos Descriptor description: |- Descriptor to uniquely identify a Fabric interconnect. x-allOf-name: firmware.NxosDescriptor allOf: - # This 'firmware.NxosDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.NxosDescriptor.List: title: List of 'firmware.NxosDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.NxosDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.NxosDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.NxosDescriptor' nullable: true firmware.PcieDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.PcieDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.PcieDescriptor' resources. x-one-of-name: firmware.PcieDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.PcieDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.PcieDescriptor: title: Firmware:Pcie Descriptor description: |- Descriptor to uniquely identify a PCIE component. x-allOf-name: firmware.PcieDescriptor allOf: - # This 'firmware.PcieDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.PcieDescriptor.List: title: List of 'firmware.PcieDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.PcieDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.PcieDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.PcieDescriptor' nullable: true firmware.PsuDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.PsuDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.PsuDescriptor' resources. x-one-of-name: firmware.PsuDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.PsuDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.PsuDescriptor: title: Firmware:Psu Descriptor description: |- Descriptor to uniquely identify a PSU component. x-allOf-name: firmware.PsuDescriptor allOf: - # This 'firmware.PsuDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.PsuDescriptor.List: title: List of 'firmware.PsuDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.PsuDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.PsuDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.PsuDescriptor' nullable: true firmware.RunningFirmware.Response: description: |- The response body of a HTTP GET request for the 'firmware.RunningFirmware' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.RunningFirmware' resources. x-one-of-name: firmware.RunningFirmware.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.RunningFirmware.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.RunningFirmware.Relationship: description: A relationship to the 'firmware.RunningFirmware' resource, or the expanded 'firmware.RunningFirmware' resource, or the 'null' value. x-one-of-name: firmware.RunningFirmware.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/firmware.RunningFirmware' firmware.RunningFirmware: title: Firmware:Running Firmware description: |- Running Firmware on an endpoint. x-allOf-name: firmware.RunningFirmware allOf: - # This 'firmware.RunningFirmware' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'firmware.RunningFirmware' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.RunningFirmware', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.RunningFirmware' ObjectType: enum: - 'firmware.RunningFirmware' Component: description: |- Kind of the firmware - boot-booloader/system/kernel. type: string readOnly: true x-omitempty: true PackageVersion: description: |- Package version which the firmware belongs to. type: string readOnly: true x-omitempty: true Type: description: |- The type of the firmware. type: string readOnly: true x-omitempty: true Version: description: |- The version of the firmware. type: string readOnly: true x-omitempty: true BiosUnit: # A Relationship to MO bios.Unit $ref: '#/components/schemas/bios.Unit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a biosUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true GraphicsCard: # A Relationship to MO graphics.Card $ref: '#/components/schemas/graphics.Card.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a graphicsCard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ManagementController: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElements: # A Relationship to MO network.Element description: An array of relationships to networkElement resources. type: array items: $ref: '#/components/schemas/network.Element.Relationship' nullable: true PciSwitch: # A Relationship to MO pci.Switch $ref: '#/components/schemas/pci.Switch.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a pciSwitch resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageController: # A Relationship to MO storage.Controller $ref: '#/components/schemas/storage.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageFlexFlashController: # A Relationship to MO storage.FlexFlashController $ref: '#/components/schemas/storage.FlexFlashController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageFlexFlashController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StoragePhysicalDisk: # A Relationship to MO storage.PhysicalDisk $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePhysicalDisk resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true firmware.RunningFirmware.List: title: List of 'firmware.RunningFirmware' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.RunningFirmware' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.RunningFirmware' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware' nullable: true firmware.SasExpanderDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.SasExpanderDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.SasExpanderDescriptor' resources. x-one-of-name: firmware.SasExpanderDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.SasExpanderDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.SasExpanderDescriptor: title: Firmware:Sas Expander Descriptor description: |- Descriptor to uniquely identify a SasExpandar component. x-allOf-name: firmware.SasExpanderDescriptor allOf: - # This 'firmware.SasExpanderDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.SasExpanderDescriptor.List: title: List of 'firmware.SasExpanderDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.SasExpanderDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.SasExpanderDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.SasExpanderDescriptor' nullable: true firmware.ServerConfigurationUtilityDistributable.Response: description: |- The response body of a HTTP GET request for the 'firmware.ServerConfigurationUtilityDistributable' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.ServerConfigurationUtilityDistributable' resources. x-one-of-name: firmware.ServerConfigurationUtilityDistributable.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.ServerConfigurationUtilityDistributable.Relationship: description: A relationship to the 'firmware.ServerConfigurationUtilityDistributable' resource, or the expanded 'firmware.ServerConfigurationUtilityDistributable' resource, or the 'null' value. x-one-of-name: firmware.ServerConfigurationUtilityDistributable.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' firmware.ServerConfigurationUtilityDistributable: title: Server Configuration Utility description: |- A server configuration utility image distributed by Cisco. x-allOf-name: firmware.ServerConfigurationUtilityDistributable allOf: - # This 'firmware.ServerConfigurationUtilityDistributable' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'firmware.ServerConfigurationUtilityDistributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.ServerConfigurationUtilityDistributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.ServerConfigurationUtilityDistributable' ObjectType: enum: - 'firmware.ServerConfigurationUtilityDistributable' Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true firmware.ServerConfigurationUtilityDistributable.List: title: List of 'firmware.ServerConfigurationUtilityDistributable' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.ServerConfigurationUtilityDistributable' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.ServerConfigurationUtilityDistributable' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' nullable: true firmware.ServerUpgradeImpact: title: Firmware:Server Upgrade Impact description: |- Impact of the server endpoint during the upgrade operation. x-allOf-name: firmware.ServerUpgradeImpact allOf: - # This 'firmware.ServerUpgradeImpact' class inherits all properties from its parent class firmware.BaseImpact. $ref: '#/components/schemas/firmware.BaseImpact' - # The definition of all the properties specified in this 'firmware.ServerUpgradeImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.ServerUpgradeImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.ServerUpgradeImpact' ObjectType: enum: - 'firmware.ServerUpgradeImpact' ImpactDetail: type: array items: description: |- List of components that will be impacted during upgrade. $ref: '#/components/schemas/firmware.ComponentImpact' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Name: description: |- Name of the server impacted by the upgrade. type: string x-omitempty: true UserLabel: description: |- Details about the server which will be impacted by the upgrade. type: string x-omitempty: true firmware.StorageControllerDescriptor.Response: description: |- The response body of a HTTP GET request for the 'firmware.StorageControllerDescriptor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.StorageControllerDescriptor' resources. x-one-of-name: firmware.StorageControllerDescriptor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.StorageControllerDescriptor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.StorageControllerDescriptor: title: Firmware:Storage Controller Descriptor description: |- Descriptor to uniquely identify a storage controller. x-allOf-name: firmware.StorageControllerDescriptor allOf: - # This 'firmware.StorageControllerDescriptor' class inherits all properties from its parent class firmware.ComponentDescriptor. $ref: '#/components/schemas/firmware.ComponentDescriptor' firmware.StorageControllerDescriptor.List: title: List of 'firmware.StorageControllerDescriptor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.StorageControllerDescriptor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.StorageControllerDescriptor' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.StorageControllerDescriptor' nullable: true firmware.SwitchUpgrade.Response: description: |- The response body of a HTTP GET request for the 'firmware.SwitchUpgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.SwitchUpgrade' resources. x-one-of-name: firmware.SwitchUpgrade.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.SwitchUpgrade.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.SwitchUpgrade: title: Firmware:Switch Upgrade description: |- Firmware upgrade operation for Fabric Interconnects that downloads the image located at Cisco/appliance/user provided HTTP repository or uses the image from a network share and upgrade. Direct download is used for upgrade that uses the image from a Cisco repository or an appliance repository. Network share is used for upgrade that use the image from a network share from your data center. x-allOf-name: firmware.SwitchUpgrade allOf: - # This 'firmware.SwitchUpgrade' class inherits all properties from its parent class firmware.UpgradeBase. $ref: '#/components/schemas/firmware.UpgradeBase' - # The definition of all the properties specified in this 'firmware.SwitchUpgrade' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.SwitchUpgrade', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.SwitchUpgrade' ObjectType: enum: - 'firmware.SwitchUpgrade' Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElements: # A Relationship to MO network.Element description: An array of relationships to networkElement resources. type: array items: $ref: '#/components/schemas/network.Element.Relationship' nullable: true x-createOnly: true firmware.SwitchUpgrade.List: title: List of 'firmware.SwitchUpgrade' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.SwitchUpgrade' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.SwitchUpgrade' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.SwitchUpgrade' nullable: true firmware.Upgrade.Response: description: |- The response body of a HTTP GET request for the 'firmware.Upgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.Upgrade' resources. x-one-of-name: firmware.Upgrade.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.Upgrade.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.Upgrade: title: Firmware:Upgrade description: |- Firmware upgrade operation for rack and blade servers that downloads the image located at Cisco/appliance/user provided HTTP repository or uses the image from a network share and upgrade. Direct download is used for upgrade that uses the image from a Cisco repository or an appliance repository. Network share is used for upgrade that use the image from a network share from your data center. x-allOf-name: firmware.Upgrade allOf: - # This 'firmware.Upgrade' class inherits all properties from its parent class firmware.UpgradeBase. $ref: '#/components/schemas/firmware.UpgradeBase' - # The definition of all the properties specified in this 'firmware.Upgrade' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.Upgrade', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.Upgrade' ObjectType: enum: - 'firmware.Upgrade' ExcludeComponentList: type: array items: description: |- The components to be excluded for server firmware upgrade. * `none` - If no component is selected for exclusion. * `local-disk` - Component to be excluded is local disk. * `storage-controller` - Component to be excluded is storage controller. type: string enum: - 'none' - 'local-disk' - 'storage-controller' default: none x-omitempty: true Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Server: # A Relationship to MO compute.Physical $ref: '#/components/schemas/compute.Physical.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computePhysical resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true firmware.Upgrade.List: title: List of 'firmware.Upgrade' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.Upgrade' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.Upgrade' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.Upgrade' nullable: true firmware.UpgradeBase.Relationship: description: A relationship to the 'firmware.UpgradeBase' resource, or the expanded 'firmware.UpgradeBase' resource, or the 'null' value. x-one-of-name: firmware.UpgradeBase.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/firmware.UpgradeBase' firmware.UpgradeBase: title: Firmware:Upgrade Base description: |- Firmware upgrade operation that downloads the image from Cisco/appliance/user provided HTTP repository or use the image from a network share and upgrade. The direct download is used for upgrade to use the image from Cisco repository or appliance repository. The network share is used for upgrade to use the image from a network share in user data center. x-allOf-name: firmware.UpgradeBase allOf: - # This 'firmware.UpgradeBase' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'firmware.UpgradeBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.UpgradeBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: DirectDownload: description: |- Direct download options in case the upgradeType is direct download based upgrade. $ref: '#/components/schemas/firmware.DirectDownload' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true FileServer: description: |- Location of the image in user software repository. $ref: '#/components/schemas/softwarerepository.FileServer' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true NetworkShare: description: |- Deprecated (Use 'fileServer' property). Network share options in case of the upgradeType is network share based upgrade. $ref: '#/components/schemas/firmware.NetworkShare' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SkipEstimateImpact: description: |- User has the option to skip the estimate impact calculation. type: boolean x-omitempty: true Status: description: |- Status of the upgrade operation. * `NONE` - Upgrade status is not populated. * `IN_PROGRESS` - The upgrade is in progress. * `SUCCESSFUL` - The upgrade successfully completed. * `FAILED` - The upgrade shows failed status. * `TERMINATED` - The upgrade has been terminated. type: string enum: - 'NONE' - 'IN_PROGRESS' - 'SUCCESSFUL' - 'FAILED' - 'TERMINATED' default: NONE x-omitempty: true UpgradeType: description: |- Desired upgrade mode to choose either direct download based upgrade or network share upgrade. * `direct_upgrade` - Upgrade mode is direct download. * `network_upgrade` - Upgrade mode is network upgrade. type: string enum: - 'direct_upgrade' - 'network_upgrade' default: direct_upgrade x-omitempty: true Distributable: # A Relationship to MO firmware.Distributable $ref: '#/components/schemas/firmware.Distributable.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareDistributable resource. When the $expand query parameter is specified, the referenced resource is returned inline. Release: # A Relationship to MO softwarerepository.Release $ref: '#/components/schemas/softwarerepository.Release.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryRelease resource. When the $expand query parameter is specified, the referenced resource is returned inline. UpgradeImpact: # A Relationship to MO firmware.UpgradeImpactStatus $ref: '#/components/schemas/firmware.UpgradeImpactStatus.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareUpgradeImpactStatus resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true UpgradeStatus: # A Relationship to MO firmware.UpgradeStatus $ref: '#/components/schemas/firmware.UpgradeStatus.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareUpgradeStatus resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true firmware.UpgradeImpact: title: Firmware:Upgrade Impact description: |- Before submitting firmware upgrade operation, the estimate impact helps to know the list of components be impacted and require host reboot. This cannot be used for network share based upgrade. x-allOf-name: firmware.UpgradeImpact allOf: - # This 'firmware.UpgradeImpact' class inherits all properties from its parent class firmware.UpgradeImpactBase. $ref: '#/components/schemas/firmware.UpgradeImpactBase' - # The definition of all the properties specified in this 'firmware.UpgradeImpact' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.UpgradeImpact', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.UpgradeImpact' ObjectType: enum: - 'firmware.UpgradeImpact' Chassis: # A Relationship to MO equipment.Chassis description: An array of relationships to equipmentChassis resources. type: array items: $ref: '#/components/schemas/equipment.Chassis.Relationship' nullable: true Device: # A Relationship to MO asset.DeviceRegistration description: An array of relationships to assetDeviceRegistration resources. type: array items: $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' nullable: true readOnly: true Distributable: # A Relationship to MO firmware.Distributable $ref: '#/components/schemas/firmware.Distributable.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareDistributable resource. When the $expand query parameter is specified, the referenced resource is returned inline. NetworkElements: # A Relationship to MO network.Element description: An array of relationships to networkElement resources. type: array items: $ref: '#/components/schemas/network.Element.Relationship' nullable: true Release: # A Relationship to MO softwarerepository.Release $ref: '#/components/schemas/softwarerepository.Release.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryRelease resource. When the $expand query parameter is specified, the referenced resource is returned inline. Server: # A Relationship to MO compute.Physical description: An array of relationships to computePhysical resources. type: array items: $ref: '#/components/schemas/compute.Physical.Relationship' nullable: true firmware.UpgradeImpactBase: title: Firmware:Upgrade Impact Base description: |- Before submitting firmware upgrade operation, the estimate impact helps to know the list of components be impacted and require host reboot. This cannot be used for network share based upgrade. x-allOf-name: firmware.UpgradeImpactBase allOf: - # This 'firmware.UpgradeImpactBase' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'firmware.UpgradeImpactBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.UpgradeImpactBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Components: type: array items: description: |- List of components to be upgraded. * `ALL` - This represents all the components. * `ALL,HDD` - This represents all the components plus the HDDs. * `None` - This represents none of the components. * `NXOS` - This represents NXOS components. * `IOM` - This represents IOM components. * `PSU` - This represents PSU components. * `CIMC` - This represents CIMC components. * `BIOS` - This represents BIOS components. * `PCIE` - This represents PCIE components. * `Drive` - This represents Storage components. * `DIMM` - This represents DIMM components. * `BoardController` - This represents Board Controller components. * `StorageController` - This represents Storage Controller components. * `HBA` - This represents HBA components. * `GPU` - This represents GPU components. * `SasExpander` - This represents SasExpander components. * `MSwitch` - This represents mSwitch components. * `CMC` - This represents CMC components. type: string enum: - 'ALL' - 'ALL,HDD' - 'None' - 'NXOS' - 'IOM' - 'PSU' - 'CIMC' - 'BIOS' - 'PCIE' - 'Drive' - 'DIMM' - 'BoardController' - 'StorageController' - 'HBA' - 'GPU' - 'SasExpander' - 'MSwitch' - 'CMC' default: ALL x-omitempty: true ComputationState: description: |- Captures the status of an upgrade impact calculation. Indicates whether the calculation is complete, in progress or the calculation is impossible due to the absence of the target image on the endpoint. * `Inprogress` - Upgrade impact calculation is in progress. * `Completed` - Upgrade impact calculation is completed. * `Unavailable` - Upgrade impact is not available since image is not present in FI. type: string enum: - 'Inprogress' - 'Completed' - 'Unavailable' default: Inprogress x-omitempty: true ExcludeComponents: type: array items: description: |- List of components to be excluded from upgrade. * `ALL` - This represents all the components. * `ALL,HDD` - This represents all the components plus the HDDs. * `None` - This represents none of the components. * `NXOS` - This represents NXOS components. * `IOM` - This represents IOM components. * `PSU` - This represents PSU components. * `CIMC` - This represents CIMC components. * `BIOS` - This represents BIOS components. * `PCIE` - This represents PCIE components. * `Drive` - This represents Storage components. * `DIMM` - This represents DIMM components. * `BoardController` - This represents Board Controller components. * `StorageController` - This represents Storage Controller components. * `HBA` - This represents HBA components. * `GPU` - This represents GPU components. * `SasExpander` - This represents SasExpander components. * `MSwitch` - This represents mSwitch components. * `CMC` - This represents CMC components. type: string enum: - 'ALL' - 'ALL,HDD' - 'None' - 'NXOS' - 'IOM' - 'PSU' - 'CIMC' - 'BIOS' - 'PCIE' - 'Drive' - 'DIMM' - 'BoardController' - 'StorageController' - 'HBA' - 'GPU' - 'SasExpander' - 'MSwitch' - 'CMC' default: ALL x-omitempty: true Impacts: type: array items: description: |- List the endpoint impacts for the selected server or fabric and selected distributable. $ref: '#/components/schemas/firmware.BaseImpact' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Summary: description: |- The summary on the component or components getting impacted by the upgrade. * `Basic` - Summary of a single instance involved in the upgrade operation. * `Detail` - Summary of the collection of single instances for a complex component involved in the upgrade operation. For example, in case of a server upgrade, a detailed summary indicates impact of all the single instances which are part of the server, such as storage controller, drives, and BIOS. type: string enum: - 'Basic' - 'Detail' default: Basic x-omitempty: true firmware.UpgradeImpactStatus.Response: description: |- The response body of a HTTP GET request for the 'firmware.UpgradeImpactStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.UpgradeImpactStatus' resources. x-one-of-name: firmware.UpgradeImpactStatus.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.UpgradeImpactStatus.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.UpgradeImpactStatus.Relationship: description: A relationship to the 'firmware.UpgradeImpactStatus' resource, or the expanded 'firmware.UpgradeImpactStatus' resource, or the 'null' value. x-one-of-name: firmware.UpgradeImpactStatus.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/firmware.UpgradeImpactStatus' firmware.UpgradeImpactStatus: title: Firmware:Upgrade Impact Status description: |- Captures the impact for an upgrade. x-allOf-name: firmware.UpgradeImpactStatus allOf: - # This 'firmware.UpgradeImpactStatus' class inherits all properties from its parent class firmware.UpgradeImpactBase. $ref: '#/components/schemas/firmware.UpgradeImpactBase' - # The definition of all the properties specified in this 'firmware.UpgradeImpactStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.UpgradeImpactStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.UpgradeImpactStatus' ObjectType: enum: - 'firmware.UpgradeImpactStatus' Upgrade: # A Relationship to MO firmware.UpgradeBase $ref: '#/components/schemas/firmware.UpgradeBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareUpgradeBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true firmware.UpgradeImpactStatus.List: title: List of 'firmware.UpgradeImpactStatus' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.UpgradeImpactStatus' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.UpgradeImpactStatus' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.UpgradeImpactStatus' nullable: true firmware.UpgradeStatus.Response: description: |- The response body of a HTTP GET request for the 'firmware.UpgradeStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'firmware.UpgradeStatus' resources. x-one-of-name: firmware.UpgradeStatus.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/firmware.UpgradeStatus.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType firmware.UpgradeStatus.Relationship: description: A relationship to the 'firmware.UpgradeStatus' resource, or the expanded 'firmware.UpgradeStatus' resource, or the 'null' value. x-one-of-name: firmware.UpgradeStatus.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/firmware.UpgradeStatus' firmware.UpgradeStatus: title: Firmware:Upgrade Status description: |- The status for the upgrade operation to include the status for the download and upgrade stages. x-allOf-name: firmware.UpgradeStatus allOf: - # This 'firmware.UpgradeStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'firmware.UpgradeStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'firmware.UpgradeStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'firmware.UpgradeStatus' ObjectType: enum: - 'firmware.UpgradeStatus' DownloadError: description: |- The error message from the endpoint during the download. type: string x-omitempty: true DownloadMessage: description: |- The message from the endpoint during the download. type: string x-omitempty: true DownloadPercentage: description: |- The percentage of the image downloaded in the endpoint. type: integer format: int64 x-omitempty: true 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 DownloadStage: description: |- The image download stages. Example:downloading, flashing. type: string x-omitempty: true EpPowerStatus: description: |- The server power status after the upgrade request is submitted in the endpoint. * `none` - Server power status is none. * `powered on` - Server power status is powered on. * `powered off` - Server power status is powered off. type: string enum: - 'none' - 'powered on' - 'powered off' default: none x-omitempty: true OverallError: description: |- The reason for the operation failure. type: string x-omitempty: true OverallPercentage: description: |- The overall percentage of the operation. type: integer format: int64 x-omitempty: true Overallstatus: description: |- The overall status of the operation. * `none` - Upgrade stage is no upgrade stage. * `started` - Upgrade stage is started. * `prepare initiating` - Upgrade configuration is being prepared. * `prepare initiated` - Upgrade configuration is initiated. * `prepared` - Upgrade configuration is prepared. * `download initiating` - Upgrade stage is download initiating. * `download initiated` - Upgrade stage is download initiated. * `downloading` - Upgrade stage is downloading. * `downloaded` - Upgrade stage is downloaded. * `upgrade initiating on fabric A` - Upgrade stage is in upgrade initiating when upgrade is being started in endopint. * `upgrade initiated on fabric A` - Upgrade stage is in upgrade initiated when the upgrade has started in endpoint. * `upgrading fabric A` - Upgrade stage is in upgrading when the upgrade requires reboot to complete. * `rebooting fabric A` - Upgrade is in rebooting when the endpoint is being rebooted. * `upgraded fabric A` - Upgrade stage is in upgraded when the corresponding endpoint has completed. * `upgrade initiating on fabric B` - Upgrade stage is in upgrade initiating when upgrade is being started in endopint. * `upgrade initiated on fabric B` - Upgrade stage is in upgrade initiated when upgrade has started in endpoint. * `upgrading fabric B` - Upgrade stage is in upgrading when the upgrade requires reboot to complete. * `rebooting fabric B` - Upgrade is in rebooting when the endpoint is being rebooted. * `upgraded fabric B` - Upgrade stage is in upgraded when the corresponding endpoint has completed. * `upgrade initiating` - Upgrade stage is upgrade initiating. * `upgrade initiated` - Upgrade stage is upgrade initiated. * `upgrading` - Upgrade stage is upgrading. * `oob images staging` - Out-of-band component images staging. * `oob images staged` - Out-of-band component images staged. * `rebooting` - Upgrade is rebooting the endpoint. * `upgraded` - Upgrade stage is upgraded. * `success` - Upgrade stage is success. * `failed` - Upgrade stage is upgrade failed. * `terminated` - Upgrade stage is terminated. * `pending` - Upgrade stage is pending. * `ReadyForCache` - The image is ready to be cached into the Intersight Appliance. * `Caching` - The image will be cached into Intersight Appliance or an endpoint cache. * `Cached` - The image has been cached into the Intersight Appliance or endpoint cache. * `CachingFailed` - The image caching into the Intersight Appliance failed or endpoint cache. type: string enum: - 'none' - 'started' - 'prepare initiating' - 'prepare initiated' - 'prepared' - 'download initiating' - 'download initiated' - 'downloading' - 'downloaded' - 'upgrade initiating on fabric A' - 'upgrade initiated on fabric A' - 'upgrading fabric A' - 'rebooting fabric A' - 'upgraded fabric A' - 'upgrade initiating on fabric B' - 'upgrade initiated on fabric B' - 'upgrading fabric B' - 'rebooting fabric B' - 'upgraded fabric B' - 'upgrade initiating' - 'upgrade initiated' - 'upgrading' - 'oob images staging' - 'oob images staged' - 'rebooting' - 'upgraded' - 'success' - 'failed' - 'terminated' - 'pending' - 'ReadyForCache' - 'Caching' - 'Cached' - 'CachingFailed' default: none x-omitempty: true PendingType: description: |- Pending reason for the upgrade waiting. * `none` - Upgrade pending reason is none. * `pending for next reboot` - Upgrade pending reason is pending for next reboot. type: string enum: - 'none' - 'pending for next reboot' default: none x-omitempty: true 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 Upgrade: # A Relationship to MO firmware.UpgradeBase $ref: '#/components/schemas/firmware.UpgradeBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareUpgradeBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Workflow: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. firmware.UpgradeStatus.List: title: List of 'firmware.UpgradeStatus' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'firmware.UpgradeStatus' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'firmware.UpgradeStatus' resources matching the request. type: array items: $ref: '#/components/schemas/firmware.UpgradeStatus' nullable: true forecast.Catalog.Response: description: |- The response body of a HTTP GET request for the 'forecast.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'forecast.Catalog' resources. x-one-of-name: forecast.Catalog.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/forecast.Catalog.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType forecast.Catalog.Relationship: description: A relationship to the 'forecast.Catalog' resource, or the expanded 'forecast.Catalog' resource, or the 'null' value. x-one-of-name: forecast.Catalog.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/forecast.Catalog' forecast.Catalog: title: Forecast:Catalog description: |- A catalog for managing forecast settings. x-allOf-name: forecast.Catalog allOf: - # This 'forecast.Catalog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'forecast.Catalog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'forecast.Catalog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'forecast.Catalog' ObjectType: enum: - 'forecast.Catalog' SchedTime: description: |- The time at which the regression model needs to run for all the metrics specified in catalog. type: string pattern: "^$|^[0-9]{2}:[0-9]{2}:[0-9]{2}" readOnly: true x-omitempty: true Version: description: |- The catalog version used in forecast configuration service. type: string readOnly: true x-omitempty: true Definition: # A Relationship to MO forecast.Definition description: An array of relationships to forecastDefinition resources. type: array items: $ref: '#/components/schemas/forecast.Definition.Relationship' nullable: true readOnly: true forecast.Catalog.List: title: List of 'forecast.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 'forecast.Catalog' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'forecast.Catalog' resources matching the request. type: array items: $ref: '#/components/schemas/forecast.Catalog' nullable: true forecast.Definition.Response: description: |- The response body of a HTTP GET request for the 'forecast.Definition' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'forecast.Definition' resources. x-one-of-name: forecast.Definition.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/forecast.Definition.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType forecast.Definition.Relationship: description: A relationship to the 'forecast.Definition' resource, or the expanded 'forecast.Definition' resource, or the 'null' value. x-one-of-name: forecast.Definition.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/forecast.Definition' forecast.Definition: title: Forecast:Definition description: |- Definition for forecast metric settings. x-allOf-name: forecast.Definition allOf: - # This 'forecast.Definition' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'forecast.Definition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'forecast.Definition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'forecast.Definition' ObjectType: enum: - 'forecast.Definition' AlertThresholdInPercentage: description: |- Threshold above which user needs to be indicated through alarm/alert. type: integer format: int64 minimum: 1 readOnly: true x-omitempty: true DataSource: description: |- Data source from where we get the data for the metrics to compute regression model. For example Druid. type: string readOnly: true x-omitempty: true MetricName: description: |- Metric for which forecast prediction is done. Metrics are defined in the catalog file. Currently its only HyperFlex cluster storage capacity usage. type: string readOnly: true x-omitempty: true MinNumOfDaysOfData: description: |- Minimum number of days of data required for computing forecast model. type: integer format: int64 minimum: 14 readOnly: true x-omitempty: true NumOfDaysOfHistoricalData: description: |- Number of days of data queried from the data source (example Druid ) which is used as input data for computing forecast model. type: integer format: int64 minimum: 14 readOnly: true x-omitempty: true PlatformType: description: |- The platform type for which we want to compute forecast. For example HyperFlex, NetworkElement. type: string readOnly: true x-omitempty: true Catalog: # A Relationship to MO forecast.Catalog $ref: '#/components/schemas/forecast.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a forecastCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true forecast.Definition.List: title: List of 'forecast.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 'forecast.Definition' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'forecast.Definition' resources matching the request. type: array items: $ref: '#/components/schemas/forecast.Definition' nullable: true forecast.Instance.Response: description: |- The response body of a HTTP GET request for the 'forecast.Instance' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'forecast.Instance' resources. x-one-of-name: forecast.Instance.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/forecast.Instance.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType forecast.Instance: title: Forecast:Instance description: |- Entity representing forecast result for instance of managed object, ie, data source. x-allOf-name: forecast.Instance allOf: - # This 'forecast.Instance' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'forecast.Instance' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'forecast.Instance', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'forecast.Instance' ObjectType: enum: - 'forecast.Instance' AltModel: type: array items: description: |- Experimental predictive model generated from the historical data using experimental algorithm. The two models are used to plot and do a comparision. type: number readOnly: true x-omitempty: true DeviceId: description: |- The Moid of the Intersight managed device instance for which regression model is derived. type: string readOnly: true x-omitempty: true FullCapDays: description: |- The number of days remaining before the device reaches its full functional capacity. type: integer format: int64 readOnly: true x-omitempty: true MetricName: description: |- The name of the metric for which regression model is generated. type: string readOnly: true x-omitempty: true MinDaysForForecast: description: |- The minimum number of days the HyperFlex cluster should be up for computing forecast. type: integer format: int64 readOnly: true x-omitempty: true Model: description: |- Predictive model generated from the historical data of a device or source. $ref: '#/components/schemas/forecast.Model' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true ThresholdDays: description: |- The number of days remaining before the device reaches the specified threshold for the metric as defined in definition. type: integer format: int64 readOnly: true x-omitempty: true ForecastDef: # A Relationship to MO forecast.Definition $ref: '#/components/schemas/forecast.Definition.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a forecastDefinition resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true forecast.Instance.List: title: List of 'forecast.Instance' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'forecast.Instance' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'forecast.Instance' resources matching the request. type: array items: $ref: '#/components/schemas/forecast.Instance' nullable: true forecast.Model: title: Forecast:Model description: |- Model encapsulated model type and the model generated based on the type for computing forecast. For example if linear regression predictive modeling is used then the model data contains slope, coefficient and RMSE. x-allOf-name: forecast.Model allOf: - # This 'forecast.Model' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'forecast.Model' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'forecast.Model', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'forecast.Model' ObjectType: enum: - 'forecast.Model' Accuracy: description: |- The standard error of the estimate is a measure of the accuracy of predictions from predective modeling. type: number format: float x-omitempty: true ModelData: type: array items: description: |- The collection of model data returned by running a predictive modeling. Data can range from slope, coefficient and more depending on the type of model used. type: number x-omitempty: true ModelType: description: |- Model type indicating type of predictive model used for computing forecast. * `Linear` - The Enum value Linear represents that the predictive model type used for forecast computation is linear regression. type: string enum: - 'Linear' default: Linear x-omitempty: true graphics.Card.Response: description: |- The response body of a HTTP GET request for the 'graphics.Card' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'graphics.Card' resources. x-one-of-name: graphics.Card.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/graphics.Card.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType graphics.Card.Relationship: description: A relationship to the 'graphics.Card' resource, or the expanded 'graphics.Card' resource, or the 'null' value. x-one-of-name: graphics.Card.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/graphics.Card' graphics.Card: title: Graphics:Card description: |- Graphics Card present in a server. x-allOf-name: graphics.Card allOf: - # This 'graphics.Card' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'graphics.Card' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'graphics.Card', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'graphics.Card' ObjectType: enum: - 'graphics.Card' CardId: description: |- The id of the graphics card. type: integer format: int64 readOnly: true x-omitempty: true DeviceId: description: |- The device id of the graphics card. type: integer format: int64 readOnly: true x-omitempty: true ExpanderSlot: description: |- The expander slot information of the card. type: string readOnly: true x-omitempty: true FirmwareVersion: description: |- The firmware version of the graphics card. type: string readOnly: true x-omitempty: true Mode: description: |- The current mode of the graphics card. type: string readOnly: true x-omitempty: true NumGpus: description: |- The number of controllers under each card. type: string x-omitempty: true OperState: description: |- The current operational state of the graphics card. type: string readOnly: true x-omitempty: true PciAddress: description: |- The PCI address of the graphics card. type: string readOnly: true x-omitempty: true PciAddressList: description: |- This list contains the PCI address of all controllers for corresponding card. type: string readOnly: true x-omitempty: true PciSlot: description: |- The PCI slot name of the graphics card. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. GraphicsControllers: # A Relationship to MO graphics.Controller description: An array of relationships to graphicsController resources. type: array items: $ref: '#/components/schemas/graphics.Controller.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningFirmware: # A Relationship to MO firmware.RunningFirmware description: An array of relationships to firmwareRunningFirmware resources. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' nullable: true readOnly: true graphics.Card.List: title: List of 'graphics.Card' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'graphics.Card' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'graphics.Card' resources matching the request. type: array items: $ref: '#/components/schemas/graphics.Card' nullable: true graphics.Controller.Response: description: |- The response body of a HTTP GET request for the 'graphics.Controller' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'graphics.Controller' resources. x-one-of-name: graphics.Controller.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/graphics.Controller.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType graphics.Controller.Relationship: description: A relationship to the 'graphics.Controller' resource, or the expanded 'graphics.Controller' resource, or the 'null' value. x-one-of-name: graphics.Controller.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/graphics.Controller' graphics.Controller: title: Graphics:Controller description: |- Controller for a Graphics Card. x-allOf-name: graphics.Controller allOf: - # This 'graphics.Controller' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'graphics.Controller' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'graphics.Controller', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'graphics.Controller' ObjectType: enum: - 'graphics.Controller' ControllerId: description: |- The id of the graphics controller. type: integer format: int64 readOnly: true x-omitempty: true PciAddr: description: |- The PCI address of the graphics controller. type: string readOnly: true x-omitempty: true PciSlot: description: |- The PCI slot information of the graphics controller. type: string readOnly: true x-omitempty: true GraphicsCard: # A Relationship to MO graphics.Card $ref: '#/components/schemas/graphics.Card.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a graphicsCard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true graphics.Controller.List: title: List of 'graphics.Controller' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'graphics.Controller' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'graphics.Controller' resources matching the request. type: array items: $ref: '#/components/schemas/graphics.Controller' nullable: true hcl.CompatibilityStatus: title: Hcl:Compatibility Status description: |- Check the compatibility status for the given hardware and software configurations. x-allOf-name: hcl.CompatibilityStatus allOf: - # This 'hcl.CompatibilityStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.CompatibilityStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.CompatibilityStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.CompatibilityStatus' ObjectType: enum: - 'hcl.CompatibilityStatus' ProfileList: type: array items: description: |- List of HardwareCompatibilityProfiles for which the compatibility status needs to be computed. $ref: '#/components/schemas/hcl.HardwareCompatibilityProfile' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 RequestType: description: |- Type of the request to be served. * `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. * `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. * `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 allOf: - # This 'hcl.Constraint' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hcl.Constraint' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.Constraint', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.Constraint' ObjectType: enum: - 'hcl.Constraint' 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.DriverImage.Response: description: |- The response body of a HTTP GET request for the 'hcl.DriverImage' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'hcl.DriverImage' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.DriverImage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.DriverImage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.DriverImage' ObjectType: enum: - 'hcl.DriverImage' 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. * `UCSM` - The server is managed by UCS Manager. * `IMC` - The server is standalone managed by CIMC. type: string enum: - 'UCSM' - 'IMC' 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'hcl.ExemptedCatalog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.ExemptedCatalog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.ExemptedCatalog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.ExemptedCatalog' ObjectType: enum: - 'hcl.ExemptedCatalog' 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 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 ProductType: description: |- Type of the product/adapter say GPU for graphic cards. * `` - Default type of the Product. * `Adapter` - Represents network adapter cards. * `StorageController` - Represents storage controllers. * `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. The '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 allOf: - # This 'hcl.Firmware' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hcl.Firmware' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.Firmware', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.Firmware' ObjectType: enum: - 'hcl.Firmware' 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. * `Success` - The input combination is valid. * `Unknown` - Unknown API request to the service. * `UnknownServer` - An invalid server model is given API requests or the server model is not present in the HCL database. * `InvalidUcsVersion` - UCS Version is not in expected format. * `ProcessorNotSupported` - Processor is not supported with the given Server or the Processor does not exist in the HCL database. * `OSNotSupported` - OS version is not supported with the given server, processor combination or OS information is not present in the HCL database. * `OSUnknown` - OS vendor or version is not known as per the HCL database. * `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. * `UcsVersionServerOSCombinationNotSupported` - Combination of UCS version, server (model and processor) and os version is not supported. * `ProductUnknown` - Product is not known as per the HCL database. * `ProductNotSupported` - Product is not supported in the given UCS version, server (model and processor) and operating system version. * `DriverNameNotSupported` - Driver protocol or name is not supported for the given product. * `FirmwareVersionNotSupported` - Firmware version not supported for the component and the server, operating system combination. * `DriverVersionNotSupported` - Driver version not supported for the component and the server, operating system combination. * `FirmwareVersionDriverVersionCombinationNotSupported` - Both Firmware and Driver versions are not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverVersionNotSupported` - Firmware and Driver version combination not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverNameNotSupported` - Firmware Version and Driver name or not supported with the component and the server, operating system combination. * `InternalError` - API requests to the service have either failed or timed out. * `MarshallingError` - Error in JSON marshalling. * `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 allOf: - # This 'hcl.HardwareCompatibilityProfile' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hcl.HardwareCompatibilityProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.HardwareCompatibilityProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.HardwareCompatibilityProfile' ObjectType: enum: - 'hcl.HardwareCompatibilityProfile' 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. * `Success` - The input combination is valid. * `Unknown` - Unknown API request to the service. * `UnknownServer` - An invalid server model is given API requests or the server model is not present in the HCL database. * `InvalidUcsVersion` - UCS Version is not in expected format. * `ProcessorNotSupported` - Processor is not supported with the given Server or the Processor does not exist in the HCL database. * `OSNotSupported` - OS version is not supported with the given server, processor combination or OS information is not present in the HCL database. * `OSUnknown` - OS vendor or version is not known as per the HCL database. * `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. * `UcsVersionServerOSCombinationNotSupported` - Combination of UCS version, server (model and processor) and os version is not supported. * `ProductUnknown` - Product is not known as per the HCL database. * `ProductNotSupported` - Product is not supported in the given UCS version, server (model and processor) and operating system version. * `DriverNameNotSupported` - Driver protocol or name is not supported for the given product. * `FirmwareVersionNotSupported` - Firmware version not supported for the component and the server, operating system combination. * `DriverVersionNotSupported` - Driver version not supported for the component and the server, operating system combination. * `FirmwareVersionDriverVersionCombinationNotSupported` - Both Firmware and Driver versions are not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverVersionNotSupported` - Firmware and Driver version combination not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverNameNotSupported` - Firmware Version and Driver name or not supported with the component and the server, operating system combination. * `InternalError` - API requests to the service have either failed or timed out. * `MarshallingError` - Error in JSON marshalling. * `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 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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. * `UCSM` - The server is managed by UCS Manager. * `IMC` - The server is standalone managed by CIMC. type: string enum: - 'UCSM' - 'IMC' default: UCSM x-omitempty: true hcl.HyperflexSoftwareCompatibilityInfo.Response: description: |- The response body of a HTTP GET request for the 'hcl.HyperflexSoftwareCompatibilityInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'hcl.HyperflexSoftwareCompatibilityInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.HyperflexSoftwareCompatibilityInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.HyperflexSoftwareCompatibilityInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.HyperflexSoftwareCompatibilityInfo' ObjectType: enum: - 'hcl.HyperflexSoftwareCompatibilityInfo' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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. * `ESXi` - ESXi hypervisor as specified by the user. * `HYPERV` - Hyperv hypervisor as specified by the user. * `KVM` - KVM hypervisor as specified by the user. type: string enum: - 'ESXi' - 'HYPERV' - 'KVM' default: ESXi x-omitempty: true HypervisorVersion: description: |- Hypervisor component software version. type: string x-omitempty: true ServerFwVersion: description: |- UCS Server Firmware component software version. type: string x-omitempty: true AppCatalog: # A Relationship to MO hyperflex.AppCatalog $ref: '#/components/schemas/hyperflex.AppCatalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAppCatalog resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' hcl.OperatingSystem: title: Hcl:Operating System description: |- Collection used to store operating system details. x-allOf-name: hcl.OperatingSystem allOf: - # This 'hcl.OperatingSystem' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.OperatingSystem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.OperatingSystem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.OperatingSystem' ObjectType: enum: - 'hcl.OperatingSystem' Version: description: |- Version of the Operating System. type: string x-omitempty: true Vendor: # A Relationship to MO hcl.OperatingSystemVendor $ref: '#/components/schemas/hcl.OperatingSystemVendor.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hclOperatingSystemVendor resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' hcl.OperatingSystemVendor: title: Hcl:Operating System Vendor description: |- Collection used to store operating system vendors details. x-allOf-name: hcl.OperatingSystemVendor allOf: - # This 'hcl.OperatingSystemVendor' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.OperatingSystemVendor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.OperatingSystemVendor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.OperatingSystemVendor' ObjectType: enum: - 'hcl.OperatingSystemVendor' 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. The '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 allOf: - # This 'hcl.Product' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hcl.Product' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.Product', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.Product' ObjectType: enum: - 'hcl.Product' DriverNames: type: array items: description: |- Supported driver names of the product. type: string x-omitempty: true ErrorCode: description: |- Error code indicating the support status. * `Success` - The input combination is valid. * `Unknown` - Unknown API request to the service. * `UnknownServer` - An invalid server model is given API requests or the server model is not present in the HCL database. * `InvalidUcsVersion` - UCS Version is not in expected format. * `ProcessorNotSupported` - Processor is not supported with the given Server or the Processor does not exist in the HCL database. * `OSNotSupported` - OS version is not supported with the given server, processor combination or OS information is not present in the HCL database. * `OSUnknown` - OS vendor or version is not known as per the HCL database. * `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. * `UcsVersionServerOSCombinationNotSupported` - Combination of UCS version, server (model and processor) and os version is not supported. * `ProductUnknown` - Product is not known as per the HCL database. * `ProductNotSupported` - Product is not supported in the given UCS version, server (model and processor) and operating system version. * `DriverNameNotSupported` - Driver protocol or name is not supported for the given product. * `FirmwareVersionNotSupported` - Firmware version not supported for the component and the server, operating system combination. * `DriverVersionNotSupported` - Driver version not supported for the component and the server, operating system combination. * `FirmwareVersionDriverVersionCombinationNotSupported` - Both Firmware and Driver versions are not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverVersionNotSupported` - Firmware and Driver version combination not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverNameNotSupported` - Firmware Version and Driver name or not supported with the component and the server, operating system combination. * `InternalError` - API requests to the service have either failed or timed out. * `MarshallingError` - Error in JSON marshalling. * `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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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. * `` - Default type of the Product. * `Adapter` - Represents network adapter cards. * `StorageController` - Represents storage controllers. * `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.ServiceStatus.Response: description: |- The response body of a HTTP GET request for the 'hcl.ServiceStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hcl.ServiceStatus' resources. x-one-of-name: hcl.ServiceStatus.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hcl.ServiceStatus.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hcl.ServiceStatus: title: Hcl:Service Status description: |- Status of the service indicatating if the service is up or under maintenance due to data update. Service will not be able serve any requests when the data is being updated. Collection will have only one document. x-allOf-name: hcl.ServiceStatus allOf: - # This 'hcl.ServiceStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.ServiceStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.ServiceStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.ServiceStatus' ObjectType: enum: - 'hcl.ServiceStatus' ExemptionFileVersion: description: |- Version of the last modified exemption file. type: string x-omitempty: true Identity: description: |- A field to uniquely identify the document with the status. type: string 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 LastImportedDataChecksum: description: |- Checksum of the data dump used as the base for delta updates. type: string x-omitempty: true Status: description: |- Status of the service indicatating if the service is up or under maintenance due to data update. * `Unknown` - Default service status. Indicates that the full import of data has failed during service startup. * `Initializing` - The service starts or restarts. * `DataRefreshing` - Full import of data is in progress. * `Active` - The data import is successful and service is ready to serve API requests. type: string enum: - 'Unknown' - 'Initializing' - 'DataRefreshing' - 'Active' default: Unknown x-omitempty: true hcl.ServiceStatus.List: title: List of 'hcl.ServiceStatus' resources description: |- This resource list is returned as a response to a HTTP GET 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.ServiceStatus' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hcl.ServiceStatus' resources matching the request. type: array items: $ref: '#/components/schemas/hcl.ServiceStatus' nullable: true hcl.SupportedDriverName: title: Hcl:Supported Driver Name description: |- Supported driver names for a given product for the given operating system. x-allOf-name: hcl.SupportedDriverName allOf: - # This 'hcl.SupportedDriverName' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hcl.SupportedDriverName' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hcl.SupportedDriverName', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hcl.SupportedDriverName' ObjectType: enum: - 'hcl.SupportedDriverName' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 hyperflex.AbstractAppSetting: title: Hyperflex:Abstract App Setting description: |- An application setting as a key/value pair. x-allOf-name: hyperflex.AbstractAppSetting allOf: - # This 'hyperflex.AbstractAppSetting' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.AbstractAppSetting' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.AbstractAppSetting', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- The application setting identifier. type: string x-omitempty: true Value: description: |- The application setting value. type: string x-omitempty: true hyperflex.Alarm.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.Alarm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.Alarm' resources. x-one-of-name: hyperflex.Alarm.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.Alarm.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.Alarm.Relationship: description: A relationship to the 'hyperflex.Alarm' resource, or the expanded 'hyperflex.Alarm' resource, or the 'null' value. x-one-of-name: hyperflex.Alarm.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.Alarm' hyperflex.Alarm: title: Hyperflex:Alarm x-allOf-name: hyperflex.Alarm allOf: - # This 'hyperflex.Alarm' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.Alarm' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.Alarm', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.Alarm' ObjectType: enum: - 'hyperflex.Alarm' Acknowledged: type: boolean readOnly: true x-omitempty: true AcknowledgedBy: type: string readOnly: true x-omitempty: true AcknowledgedTime: type: integer format: int64 readOnly: true x-omitempty: true AcknowledgedTimeAsUtc: type: string readOnly: true x-omitempty: true Description: type: string readOnly: true x-omitempty: true EntityData: type: string readOnly: true x-omitempty: true EntityName: type: string readOnly: true x-omitempty: true EntityType: type: string enum: - 'UNKNOWN' - 'DISK' - 'NODE' - 'CLUSTER' - 'DATASTORE' - 'ZONE' - 'VIRTUALMACHINE' default: UNKNOWN readOnly: true x-omitempty: true EntityUuId: type: string readOnly: true x-omitempty: true Message: type: string readOnly: true x-omitempty: true Name: type: string readOnly: true x-omitempty: true Status: type: string enum: - 'UNKNOWN' - 'CLEARED' - 'INFO' - 'WARNING' - 'CRITICAL' default: UNKNOWN readOnly: true x-omitempty: true TriggeredTime: type: integer format: int64 readOnly: true x-omitempty: true TriggeredTimeAsUtc: type: string readOnly: true x-omitempty: true Uuid: type: string readOnly: true x-omitempty: true Cluster: # A Relationship to MO hyperflex.Cluster $ref: '#/components/schemas/hyperflex.Cluster.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexCluster resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true hyperflex.Alarm.List: title: List of 'hyperflex.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 'hyperflex.Alarm' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.Alarm' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.Alarm' nullable: true hyperflex.AlarmSummary: title: Hyperflex:Alarm Summary description: |- The summary of alarm counts based on alarm serverity. x-allOf-name: hyperflex.AlarmSummary allOf: - # This 'hyperflex.AlarmSummary' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.AlarmSummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.AlarmSummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.AlarmSummary' ObjectType: enum: - 'hyperflex.AlarmSummary' Critical: description: |- The count of alarms that have severity type Critical. type: integer format: int64 x-omitempty: true Warning: description: |- The count of alarms that have severity type Warning. type: integer format: int64 x-omitempty: true hyperflex.AppCatalog.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.AppCatalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.AppCatalog' resources. x-one-of-name: hyperflex.AppCatalog.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.AppCatalog.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.AppCatalog.Relationship: description: A relationship to the 'hyperflex.AppCatalog' resource, or the expanded 'hyperflex.AppCatalog' resource, or the 'null' value. x-one-of-name: hyperflex.AppCatalog.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.AppCatalog' hyperflex.AppCatalog: title: HyperFlex application settings description: |- A catalog for managing application settings for HyperFlex cluster configuration service. x-allOf-name: hyperflex.AppCatalog allOf: - # This 'hyperflex.AppCatalog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.AppCatalog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.AppCatalog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.AppCatalog' ObjectType: enum: - 'hyperflex.AppCatalog' Version: description: |- The catalog version used in HyperFlex cluster configuration service. type: string x-omitempty: true FeatureLimitExternal: # A Relationship to MO hyperflex.FeatureLimitExternal $ref: '#/components/schemas/hyperflex.FeatureLimitExternal.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexFeatureLimitExternal resource. When the $expand query parameter is specified, the referenced resource is returned inline. FeatureLimitInternal: # A Relationship to MO hyperflex.FeatureLimitInternal $ref: '#/components/schemas/hyperflex.FeatureLimitInternal.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexFeatureLimitInternal resource. When the $expand query parameter is specified, the referenced resource is returned inline. HxdpVersions: # A Relationship to MO hyperflex.HxdpVersion description: An array of relationships to hyperflexHxdpVersion resources. type: array items: $ref: '#/components/schemas/hyperflex.HxdpVersion.Relationship' nullable: true HyperflexCapabilityInfos: # A Relationship to MO hyperflex.CapabilityInfo description: An array of relationships to hyperflexCapabilityInfo resources. type: array items: $ref: '#/components/schemas/hyperflex.CapabilityInfo.Relationship' nullable: true HyperflexSoftwareCompatibilityInfos: # A Relationship to MO hcl.HyperflexSoftwareCompatibilityInfo description: An array of relationships to hclHyperflexSoftwareCompatibilityInfo resources. type: array items: $ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo.Relationship' nullable: true ServerFirmwareVersion: # A Relationship to MO hyperflex.ServerFirmwareVersion $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexServerFirmwareVersion resource. When the $expand query parameter is specified, the referenced resource is returned inline. ServerModel: # A Relationship to MO hyperflex.ServerModel $ref: '#/components/schemas/hyperflex.ServerModel.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexServerModel resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.AppCatalog.List: title: List of 'hyperflex.AppCatalog' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.AppCatalog' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.AppCatalog' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.AppCatalog' nullable: true hyperflex.AppSettingConstraint: title: Hyperflex:App Setting Constraint description: |- A constraint that can be used to qualify an application setting. x-allOf-name: hyperflex.AppSettingConstraint allOf: - # This 'hyperflex.AppSettingConstraint' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.AppSettingConstraint' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.AppSettingConstraint', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.AppSettingConstraint' ObjectType: enum: - 'hyperflex.AppSettingConstraint' HxdpVersion: description: |- The supported HyperFlex Data Platform version in regex format. type: string x-omitempty: true HypervisorType: description: |- The hypervisor type for the HyperFlex cluster. * `ESXi` - ESXi hypervisor as specified by the user. * `HYPERV` - Hyperv hypervisor as specified by the user. * `KVM` - KVM hypervisor as specified by the user. type: string enum: - 'ESXi' - 'HYPERV' - 'KVM' default: ESXi x-omitempty: true MgmtPlatform: description: |- The supported management platform for the HyperFlex Cluster. * `FI` - The host servers used in the cluster deployment are managed by a UCS Fabric Interconnect. * `EDGE` - The host servers used in the cluster deployment are standalone severs. type: string enum: - 'FI' - 'EDGE' default: FI x-omitempty: true ServerModel: description: |- The supported server models in regex format. type: string x-omitempty: true hyperflex.AutoSupportPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.AutoSupportPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.AutoSupportPolicy' resources. x-one-of-name: hyperflex.AutoSupportPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.AutoSupportPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.AutoSupportPolicy.Relationship: description: A relationship to the 'hyperflex.AutoSupportPolicy' resource, or the expanded 'hyperflex.AutoSupportPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.AutoSupportPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' hyperflex.AutoSupportPolicy: title: Auto Support description: |- A policy specifying the configuration to automatically generate support tickets with Cisco TAC. x-allOf-name: hyperflex.AutoSupportPolicy allOf: - # This 'hyperflex.AutoSupportPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.AutoSupportPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.AutoSupportPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.AutoSupportPolicy' ObjectType: enum: - 'hyperflex.AutoSupportPolicy' AdminState: description: |- Enable or disable Auto Support. type: boolean x-omitempty: true ServiceTicketReceipient: description: |- The recipient email address for support tickets. 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 ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.AutoSupportPolicy.List: title: List of 'hyperflex.AutoSupportPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.AutoSupportPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.AutoSupportPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.AutoSupportPolicy' nullable: true hyperflex.CapabilityInfo.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.CapabilityInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.CapabilityInfo' resources. x-one-of-name: hyperflex.CapabilityInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.CapabilityInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.CapabilityInfo.Relationship: description: A relationship to the 'hyperflex.CapabilityInfo' resource, or the expanded 'hyperflex.CapabilityInfo' resource, or the 'null' value. x-one-of-name: hyperflex.CapabilityInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.CapabilityInfo' hyperflex.CapabilityInfo: title: Hyperflex Capabilities and Feature limits Information description: |- A capabilityInfo is like a feature set and/or feature limit for different components of a HyperFlex Cluster. A set of constraints defines the rules, and the corresponding value either determines if the feature would work on a HyperFlex cluster with specific component set, or corresponds to a limit for a set of HyperFlex components. For example, "minUcsVersion" for HyperFlex version "4.0.1a" corresponds to "3.2.3" or "minHxdpVersion" for HyperFlex Upgrade operation is "4.0.1a" etc. This data can be captured as a capability and at run-time, decision can be made to proceed with the intended operation or not, or proceed with the intended operation with a value catered to specific feature sets. x-allOf-name: hyperflex.CapabilityInfo allOf: - # This 'hyperflex.CapabilityInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.CapabilityInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.CapabilityInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.CapabilityInfo' ObjectType: enum: - 'hyperflex.CapabilityInfo' CapabilityConstraints: type: array items: description: |- Collection of constraints, which when applied together in tandem with an "AND" assertion, will correspond to the specified Value. Hence the Value will make sense only iff all the constraints match. $ref: '#/components/schemas/hcl.Constraint' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Name: description: |- Name of the capability or feature set consisting of a collection of constraint rules and value. type: string x-omitempty: true Value: description: |- Capability Value which is valid only iff all specified constraints match. type: string readOnly: true x-omitempty: true AppCatalog: # A Relationship to MO hyperflex.AppCatalog $ref: '#/components/schemas/hyperflex.AppCatalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAppCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.CapabilityInfo.List: title: List of 'hyperflex.CapabilityInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.CapabilityInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.CapabilityInfo' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.CapabilityInfo' nullable: true hyperflex.Cluster.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.Cluster' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.Cluster' resources. x-one-of-name: hyperflex.Cluster.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.Cluster.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.Cluster.Relationship: description: A relationship to the 'hyperflex.Cluster' resource, or the expanded 'hyperflex.Cluster' resource, or the 'null' value. x-one-of-name: hyperflex.Cluster.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.Cluster' hyperflex.Cluster: title: Hyperflex:Cluster description: |- A HyperFlex cluster. Contains inventory information concerning the health, software versions, storage, and nodes of the cluster. x-allOf-name: hyperflex.Cluster allOf: - # This 'hyperflex.Cluster' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.Cluster' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.Cluster', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.Cluster' ObjectType: enum: - 'hyperflex.Cluster' AlarmSummary: description: |- The summary of alarm counts based on the severity types (Critical or Warning). $ref: '#/components/schemas/hyperflex.AlarmSummary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true CapacityRunway: description: |- The number of days remaining before the cluster's storage utilization reaches the recommended capacity limit of 76%. Default value is math.MaxInt32 to indicate that the capacity runway is "Unknown" for a cluster that is not connected or with not sufficient data. type: integer format: int64 readOnly: true x-omitempty: true ClusterName: description: |- The name of this HyperFlex cluster. type: string readOnly: true x-omitempty: true ClusterType: description: |- The storage type of this cluster (All Flash or Hybrid). type: integer format: int64 readOnly: true x-omitempty: true ClusterUuid: description: |- The unique identifier for this HyperFlex cluster. type: string readOnly: true x-omitempty: true ComputeNodeCount: description: |- The number of compute nodes that belong to this cluster. type: integer format: int64 readOnly: true x-omitempty: true ConvergedNodeCount: description: |- The number of converged nodes that belong to this cluster. type: integer format: int64 readOnly: true x-omitempty: true DeploymentType: description: |- The deployment type of the HyperFlex cluster. The cluster can have one of the following configurations: 1. Datacenter: The HyperFlex cluster consists of UCS Fabric Interconnect-attached nodes on a single site. 2. Stretched Cluster: The HyperFlex cluster consists of UCS Fabric Interconnect-attached nodes distributed across multiple sites. 3. Edge: The HyperFlex cluster consists of 2-4 standalone nodes. If the cluster is running a HyperFlex Data Platform version less than 4.0 or if the deployment type cannot be determined, the deployment type is set as 'NA' (not available). * `NA` - The deployment type of the HyperFlex cluster is not available. * `Datacenter` - The deployment type of a HyperFlex cluster consisting of UCS Fabric Interconnect-attached nodes on the same site. * `Stretched Cluster` - The deployment type of a HyperFlex cluster consisting of UCS Fabric Interconnect-attached nodes across different sites. * `Edge` - The deployment type of a HyperFlex cluster consisting of 2-4 standalone nodes. type: string enum: - 'NA' - 'Datacenter' - 'Stretched Cluster' - 'Edge' default: NA readOnly: true x-omitempty: true DeviceId: description: |- The unique identifier of the device registration that represents this HyperFlex cluster's connection to Intersight. type: string readOnly: true x-omitempty: true FltAggr: description: |- The number of yellow (warning) and red (critical) alarms stored as an aggregate. The first 16 bits indicate the number of red alarms, and the last 16 bits contain the number of yellow alarms. deprecated: true type: integer format: int64 readOnly: true x-omitempty: true HxVersion: description: |- The HyperFlex Data Platform version of this cluster. type: string readOnly: true x-omitempty: true HxdpBuildVersion: description: |- The version and build number of the HyperFlex Data Platform for this cluster. After a cluster upgrade, this version string will be updated on the next inventory cycle to reflect the newly installed version. type: string readOnly: true x-omitempty: true HypervisorType: description: |- The type of hypervisor running on this cluster. * `ESXi` - ESXi hypervisor as specified by the user. * `HYPERV` - Hyperv hypervisor as specified by the user. * `KVM` - KVM hypervisor as specified by the user. type: string enum: - 'ESXi' - 'HYPERV' - 'KVM' default: ESXi readOnly: true x-omitempty: true HypervisorVersion: description: |- The version of hypervisor running on this cluster. type: string readOnly: true x-omitempty: true Summary: description: |- The summary of HyperFlex cluster health, storage, and number of nodes. $ref: '#/components/schemas/hyperflex.Summary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true UtilizationPercentage: description: |- The storage utilization percentage is computed based on total capacity and current capacity utilization. type: number format: float readOnly: true x-omitempty: true UtilizationTrendPercentage: description: |- The storage utilization trend percentage represents the trend in percentage computed using the first and last point from historical data. type: number format: float readOnly: true x-omitempty: true VmCount: description: |- The number of virtual machines present on this cluster. type: integer format: int64 readOnly: true x-omitempty: true Alarm: # A Relationship to MO hyperflex.Alarm description: An array of relationships to hyperflexAlarm resources. type: array items: $ref: '#/components/schemas/hyperflex.Alarm.Relationship' nullable: true readOnly: true Health: # A Relationship to MO hyperflex.Health $ref: '#/components/schemas/hyperflex.Health.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexHealth resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Nodes: # A Relationship to MO hyperflex.Node description: An array of relationships to hyperflexNode resources. type: array items: $ref: '#/components/schemas/hyperflex.Node.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true hyperflex.Cluster.List: title: List of 'hyperflex.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 'hyperflex.Cluster' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.Cluster' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.Cluster' nullable: true hyperflex.ClusterNetworkPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ClusterNetworkPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ClusterNetworkPolicy' resources. x-one-of-name: hyperflex.ClusterNetworkPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ClusterNetworkPolicy.Relationship: description: A relationship to the 'hyperflex.ClusterNetworkPolicy' resource, or the expanded 'hyperflex.ClusterNetworkPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.ClusterNetworkPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' hyperflex.ClusterNetworkPolicy: title: Network Configuration description: |- A policy specifying VLANs for management, VM migration, and VM traffic. x-allOf-name: hyperflex.ClusterNetworkPolicy allOf: - # This 'hyperflex.ClusterNetworkPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.ClusterNetworkPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ClusterNetworkPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ClusterNetworkPolicy' ObjectType: enum: - 'hyperflex.ClusterNetworkPolicy' JumboFrame: description: |- Enable or disable jumbo frames. type: boolean x-omitempty: true KvmIpRange: description: |- The Out-of-band KVM IP range. Configures the service profiles to use IP addresses within this range for setting the KVM IP of a server. $ref: '#/components/schemas/hyperflex.IpAddrRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MacPrefixRange: description: |- The MAC address prefix range for configuring vNICs. Configures the service profiles to use MAC address prefixes within this range for setting the MAC address of server vNICs. $ref: '#/components/schemas/hyperflex.MacAddrPrefixRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MgmtVlan: description: |- The VLAN for the management network. $ref: '#/components/schemas/hyperflex.NamedVlan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true UplinkSpeed: description: |- Link speed of the server adapter port to the upstream switch. When the policy is attached to a cluster profile with EDGE management platform, the uplink speed can be '1G' or '10G+'. Use '10G+' for link speeds of 10G or above. When the policy is attached to a cluster profile with Fabric Interconnect management platform, the uplink speed can be 'default' only. * `default` - Current default value set on the hardware platform. * `1G` - A link speed of 1 gigabit per second. * `10G` - A link speed of 10 gigabits per second or above. type: string enum: - 'default' - '1G' - '10G' default: default x-omitempty: true VmMigrationVlan: description: |- The VM migration VLAN. This VLAN is used for transfering VMs from one host to another during operations such a cluster upgrade. $ref: '#/components/schemas/hyperflex.NamedVlan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true VmNetworkVlans: type: array items: description: |- The VLANs for VM traffic. Guest VMs hosted on the HyperFlex cluster use these VLANs for network communication. $ref: '#/components/schemas/hyperflex.NamedVlan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.ClusterNetworkPolicy.List: title: List of 'hyperflex.ClusterNetworkPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ClusterNetworkPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ClusterNetworkPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' nullable: true hyperflex.ClusterProfile.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ClusterProfile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ClusterProfile' resources. x-one-of-name: hyperflex.ClusterProfile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ClusterProfile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ClusterProfile.Relationship: description: A relationship to the 'hyperflex.ClusterProfile' resource, or the expanded 'hyperflex.ClusterProfile' resource, or the 'null' value. x-one-of-name: hyperflex.ClusterProfile.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ClusterProfile' hyperflex.ClusterProfile: title: HyperFlex Cluster Profile description: |- A profile specifying configuration settings for a HyperFlex cluster. x-allOf-name: hyperflex.ClusterProfile allOf: - # This 'hyperflex.ClusterProfile' class inherits all properties from its parent class policy.AbstractConfigProfile. $ref: '#/components/schemas/policy.AbstractConfigProfile' - # The definition of all the properties specified in this 'hyperflex.ClusterProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ClusterProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ClusterProfile' ObjectType: enum: - 'hyperflex.ClusterProfile' DataIpAddress: description: |- The storage data IP address for the HyperFlex cluster. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true HypervisorType: description: |- The hypervisor type for the HyperFlex cluster. * `ESXi` - ESXi hypervisor as specified by the user. * `HYPERV` - Hyperv hypervisor as specified by the user. * `KVM` - KVM hypervisor as specified by the user. type: string enum: - 'ESXi' - 'HYPERV' - 'KVM' default: ESXi x-omitempty: true MacAddressPrefix: description: |- The MAC address prefix in the form of 00:25:B5:XX. type: string pattern: "^$|^00:25:B5:[0-9a-fA-F]{2}$" x-omitempty: true MgmtIpAddress: description: |- The management IP address for the HyperFlex cluster. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true MgmtPlatform: description: |- The management platform for the HyperFlex cluster. * `FI` - The host servers used in the cluster deployment are managed by a UCS Fabric Interconnect. * `EDGE` - The host servers used in the cluster deployment are standalone severs. type: string enum: - 'FI' - 'EDGE' default: FI x-createOnly: true x-omitempty: true Replication: description: |- The number of copies of each data block written. type: integer format: int64 x-omitempty: true StorageDataVlan: description: |- The VLAN for the HyperFlex storage data traffic. $ref: '#/components/schemas/hyperflex.NamedVlan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true WwxnPrefix: description: |- The WWxN prefix in the form of 20:00:00:25:B5:XX. type: string pattern: "^$|^20:00:00:25:B5:[0-9a-fA-F]{2}$" x-omitempty: true AssociatedCluster: # A Relationship to MO hyperflex.Cluster $ref: '#/components/schemas/hyperflex.Cluster.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexCluster resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true AutoSupport: # A Relationship to MO hyperflex.AutoSupportPolicy $ref: '#/components/schemas/hyperflex.AutoSupportPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAutoSupportPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. ClusterNetwork: # A Relationship to MO hyperflex.ClusterNetworkPolicy $ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexClusterNetworkPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. ClusterStorage: # A Relationship to MO hyperflex.ClusterStoragePolicy $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexClusterStoragePolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. ConfigResult: # A Relationship to MO hyperflex.ConfigResult $ref: '#/components/schemas/hyperflex.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ExtFcStorage: # A Relationship to MO hyperflex.ExtFcStoragePolicy $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexExtFcStoragePolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. ExtIscsiStorage: # A Relationship to MO hyperflex.ExtIscsiStoragePolicy $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexExtIscsiStoragePolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. LocalCredential: # A Relationship to MO hyperflex.LocalCredentialPolicy $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexLocalCredentialPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. NodeConfig: # A Relationship to MO hyperflex.NodeConfigPolicy $ref: '#/components/schemas/hyperflex.NodeConfigPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexNodeConfigPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. NodeProfileConfig: # A Relationship to MO hyperflex.NodeProfile description: An array of relationships to hyperflexNodeProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.NodeProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true ProxySetting: # A Relationship to MO hyperflex.ProxySettingPolicy $ref: '#/components/schemas/hyperflex.ProxySettingPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexProxySettingPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. RunningWorkflows: # A Relationship to MO workflow.WorkflowInfo description: An array of relationships to workflowWorkflowInfo resources. type: array items: $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' nullable: true readOnly: true SoftwareVersion: # A Relationship to MO hyperflex.SoftwareVersionPolicy $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexSoftwareVersionPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. SysConfig: # A Relationship to MO hyperflex.SysConfigPolicy $ref: '#/components/schemas/hyperflex.SysConfigPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexSysConfigPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. UcsmConfig: # A Relationship to MO hyperflex.UcsmConfigPolicy $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexUcsmConfigPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. VcenterConfig: # A Relationship to MO hyperflex.VcenterConfigPolicy $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexVcenterConfigPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.ClusterProfile.List: title: List of 'hyperflex.ClusterProfile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ClusterProfile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ClusterProfile' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile' nullable: true hyperflex.ClusterStoragePolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ClusterStoragePolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ClusterStoragePolicy' resources. x-one-of-name: hyperflex.ClusterStoragePolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ClusterStoragePolicy.Relationship: description: A relationship to the 'hyperflex.ClusterStoragePolicy' resource, or the expanded 'hyperflex.ClusterStoragePolicy' resource, or the 'null' value. x-one-of-name: hyperflex.ClusterStoragePolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' hyperflex.ClusterStoragePolicy: title: Storage Configuration description: |- A policy specifying HyperFlex cluster storage settings (optional). x-allOf-name: hyperflex.ClusterStoragePolicy allOf: - # This 'hyperflex.ClusterStoragePolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.ClusterStoragePolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ClusterStoragePolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ClusterStoragePolicy' ObjectType: enum: - 'hyperflex.ClusterStoragePolicy' DiskPartitionCleanup: description: |- If enabled, formats existing disk partitions (destroys all user data). type: boolean x-omitempty: true LogicalAvalabilityZoneConfig: description: |- Enable or disable Logical Availability Zones (LAZ). If enabled, HyperFlex Data Platform automatically selects and groups nodes into different availability zones. For HyperFlex Data Platform versions prior to 3.0 release, this setting does not apply. For HyperFlex Data Platform versions 3.0 or higher, this setting is only applicable to Fabric Interconnect attached HyperFlex systems with 8 or more converged nodes. $ref: '#/components/schemas/hyperflex.LogicalAvailabilityZone' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true VdiOptimization: description: |- Enable or disable VDI optimization (hybrid HyperFlex systems only). type: boolean x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.ClusterStoragePolicy.List: title: List of 'hyperflex.ClusterStoragePolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ClusterStoragePolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ClusterStoragePolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ClusterStoragePolicy' nullable: true hyperflex.ConfigResult.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ConfigResult' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ConfigResult' resources. x-one-of-name: hyperflex.ConfigResult.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ConfigResult.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ConfigResult.Relationship: description: A relationship to the 'hyperflex.ConfigResult' resource, or the expanded 'hyperflex.ConfigResult' resource, or the 'null' value. x-one-of-name: hyperflex.ConfigResult.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ConfigResult' hyperflex.ConfigResult: title: Hyperflex:Config Result description: |- Profile configuration (deploy, validation) results with the overall state and detailed result messages. x-allOf-name: hyperflex.ConfigResult allOf: - # This 'hyperflex.ConfigResult' class inherits all properties from its parent class policy.AbstractConfigResult. $ref: '#/components/schemas/policy.AbstractConfigResult' - # The definition of all the properties specified in this 'hyperflex.ConfigResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ConfigResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ConfigResult' ObjectType: enum: - 'hyperflex.ConfigResult' ConfigProgress: description: |- The progress percentage of the running configuration or workflow. type: string x-omitempty: true Duration: description: |- The duration of the running configuration or workflow. type: string x-omitempty: true StartTime: description: |- The start time of the configuration or workflow. type: string x-omitempty: true ClusterProfile: # A Relationship to MO hyperflex.ClusterProfile $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexClusterProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ResultEntries: # A Relationship to MO hyperflex.ConfigResultEntry description: An array of relationships to hyperflexConfigResultEntry resources. type: array items: $ref: '#/components/schemas/hyperflex.ConfigResultEntry.Relationship' nullable: true hyperflex.ConfigResult.List: title: List of 'hyperflex.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 'hyperflex.ConfigResult' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ConfigResult' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ConfigResult' nullable: true hyperflex.ConfigResultEntry.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ConfigResultEntry' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ConfigResultEntry' resources. x-one-of-name: hyperflex.ConfigResultEntry.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ConfigResultEntry.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ConfigResultEntry.Relationship: description: A relationship to the 'hyperflex.ConfigResultEntry' resource, or the expanded 'hyperflex.ConfigResultEntry' resource, or the 'null' value. x-one-of-name: hyperflex.ConfigResultEntry.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ConfigResultEntry' hyperflex.ConfigResultEntry: title: Hyperflex:Config Result Entry description: |- An entry that describes the result of a cluster validation or deployment operation. x-allOf-name: hyperflex.ConfigResultEntry allOf: - # This 'hyperflex.ConfigResultEntry' class inherits all properties from its parent class policy.AbstractConfigResultEntry. $ref: '#/components/schemas/policy.AbstractConfigResultEntry' - # The definition of all the properties specified in this 'hyperflex.ConfigResultEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ConfigResultEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ConfigResultEntry' ObjectType: enum: - 'hyperflex.ConfigResultEntry' ConfigResult: # A Relationship to MO hyperflex.ConfigResult $ref: '#/components/schemas/hyperflex.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.ConfigResultEntry.List: title: List of 'hyperflex.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 'hyperflex.ConfigResultEntry' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ConfigResultEntry' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ConfigResultEntry' nullable: true hyperflex.ExtFcStoragePolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ExtFcStoragePolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ExtFcStoragePolicy' resources. x-one-of-name: hyperflex.ExtFcStoragePolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ExtFcStoragePolicy.Relationship: description: A relationship to the 'hyperflex.ExtFcStoragePolicy' resource, or the expanded 'hyperflex.ExtFcStoragePolicy' resource, or the 'null' value. x-one-of-name: hyperflex.ExtFcStoragePolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' hyperflex.ExtFcStoragePolicy: title: External FC Storage description: |- A policy specifying external storage connectivity information via Fabric attached FC storage. x-allOf-name: hyperflex.ExtFcStoragePolicy allOf: - # This 'hyperflex.ExtFcStoragePolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.ExtFcStoragePolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ExtFcStoragePolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ExtFcStoragePolicy' ObjectType: enum: - 'hyperflex.ExtFcStoragePolicy' AdminState: description: |- Enables or disables external FC storage configuration. type: boolean x-omitempty: true ExtaTraffic: description: |- VSAN for the primary Fabric Interconnect external FC storage traffic. $ref: '#/components/schemas/hyperflex.NamedVsan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ExtbTraffic: description: |- VSAN for the secondary Fabric Interconnect external FC storage traffic. $ref: '#/components/schemas/hyperflex.NamedVsan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true WwxnPrefixRange: description: |- The range of WWxN addresses to use for the FC storage configuration. $ref: '#/components/schemas/hyperflex.WwxnPrefixRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.ExtFcStoragePolicy.List: title: List of 'hyperflex.ExtFcStoragePolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ExtFcStoragePolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ExtFcStoragePolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ExtFcStoragePolicy' nullable: true hyperflex.ExtIscsiStoragePolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ExtIscsiStoragePolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ExtIscsiStoragePolicy' resources. x-one-of-name: hyperflex.ExtIscsiStoragePolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ExtIscsiStoragePolicy.Relationship: description: A relationship to the 'hyperflex.ExtIscsiStoragePolicy' resource, or the expanded 'hyperflex.ExtIscsiStoragePolicy' resource, or the 'null' value. x-one-of-name: hyperflex.ExtIscsiStoragePolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' hyperflex.ExtIscsiStoragePolicy: title: External iSCSI Storage description: |- A policy specifying external storage connectivity information via Fabric attached FCoE storage. x-allOf-name: hyperflex.ExtIscsiStoragePolicy allOf: - # This 'hyperflex.ExtIscsiStoragePolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.ExtIscsiStoragePolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ExtIscsiStoragePolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ExtIscsiStoragePolicy' ObjectType: enum: - 'hyperflex.ExtIscsiStoragePolicy' AdminState: description: |- Enable or disable external FCoE storage configuration. type: boolean x-omitempty: true ExtaTraffic: description: |- VLAN for the primary Fabric Interconnect external FCoE storage traffic. $ref: '#/components/schemas/hyperflex.NamedVlan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ExtbTraffic: description: |- VLAN for the secondary Fabric Interconnect external FCoE storage traffic. $ref: '#/components/schemas/hyperflex.NamedVlan' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.ExtIscsiStoragePolicy.List: title: List of 'hyperflex.ExtIscsiStoragePolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ExtIscsiStoragePolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ExtIscsiStoragePolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ExtIscsiStoragePolicy' nullable: true hyperflex.FeatureLimitEntry: title: Hyperflex:Feature Limit Entry description: |- A HyperFlex feature limit. Feature limits are used to specify which HyperFlex configurations are compatible with a given feature. x-allOf-name: hyperflex.FeatureLimitEntry allOf: - # This 'hyperflex.FeatureLimitEntry' class inherits all properties from its parent class hyperflex.AbstractAppSetting. $ref: '#/components/schemas/hyperflex.AbstractAppSetting' - # The definition of all the properties specified in this 'hyperflex.FeatureLimitEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.FeatureLimitEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.FeatureLimitEntry' ObjectType: enum: - 'hyperflex.FeatureLimitEntry' Constraint: description: |- The conditions that must be satisfied before applying the AppSetting. $ref: '#/components/schemas/hyperflex.AppSettingConstraint' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true hyperflex.FeatureLimitExternal.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.FeatureLimitExternal' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.FeatureLimitExternal' resources. x-one-of-name: hyperflex.FeatureLimitExternal.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.FeatureLimitExternal.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.FeatureLimitExternal.Relationship: description: A relationship to the 'hyperflex.FeatureLimitExternal' resource, or the expanded 'hyperflex.FeatureLimitExternal' resource, or the 'null' value. x-one-of-name: hyperflex.FeatureLimitExternal.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' hyperflex.FeatureLimitExternal: title: Hyperflex:Feature Limit External description: |- The HyperFlex feature limits that are available to end users. x-allOf-name: hyperflex.FeatureLimitExternal allOf: - # This 'hyperflex.FeatureLimitExternal' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.FeatureLimitExternal' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.FeatureLimitExternal', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.FeatureLimitExternal' ObjectType: enum: - 'hyperflex.FeatureLimitExternal' FeatureLimitEntries: type: array items: description: |- The HyperFlex feature limits which are made available to users. $ref: '#/components/schemas/hyperflex.FeatureLimitEntry' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AppCatalog: # A Relationship to MO hyperflex.AppCatalog $ref: '#/components/schemas/hyperflex.AppCatalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAppCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.FeatureLimitExternal.List: title: List of 'hyperflex.FeatureLimitExternal' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.FeatureLimitExternal' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.FeatureLimitExternal' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.FeatureLimitExternal' nullable: true hyperflex.FeatureLimitInternal.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.FeatureLimitInternal' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.FeatureLimitInternal' resources. x-one-of-name: hyperflex.FeatureLimitInternal.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.FeatureLimitInternal.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.FeatureLimitInternal.Relationship: description: A relationship to the 'hyperflex.FeatureLimitInternal' resource, or the expanded 'hyperflex.FeatureLimitInternal' resource, or the 'null' value. x-one-of-name: hyperflex.FeatureLimitInternal.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' hyperflex.FeatureLimitInternal: title: Hyperflex:Feature Limit Internal description: |- The HyperFlex installer feature limits for internal system use. x-allOf-name: hyperflex.FeatureLimitInternal allOf: - # This 'hyperflex.FeatureLimitInternal' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.FeatureLimitInternal' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.FeatureLimitInternal', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.FeatureLimitInternal' ObjectType: enum: - 'hyperflex.FeatureLimitInternal' FeatureLimitEntries: type: array items: description: |- The HyperFlex feature limits for internal use. $ref: '#/components/schemas/hyperflex.FeatureLimitEntry' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AppCatalog: # A Relationship to MO hyperflex.AppCatalog $ref: '#/components/schemas/hyperflex.AppCatalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAppCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.FeatureLimitInternal.List: title: List of 'hyperflex.FeatureLimitInternal' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.FeatureLimitInternal' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.FeatureLimitInternal' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.FeatureLimitInternal' nullable: true hyperflex.Health.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.Health' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.Health' resources. x-one-of-name: hyperflex.Health.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.Health.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.Health.Relationship: description: A relationship to the 'hyperflex.Health' resource, or the expanded 'hyperflex.Health' resource, or the 'null' value. x-one-of-name: hyperflex.Health.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.Health' hyperflex.Health: title: Hyperflex:Health x-allOf-name: hyperflex.Health allOf: - # This 'hyperflex.Health' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.Health' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.Health', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.Health' ObjectType: enum: - 'hyperflex.Health' ArbitrationServiceState: type: string enum: - 'NOT_AVAILABLE' - 'UNKNOWN' - 'ONLINE' - 'OFFLINE' default: NOT_AVAILABLE readOnly: true x-omitempty: true DataReplicationCompliance: type: string enum: - 'UNKNOWN' - 'COMPLIANT' - 'NON_COMPLIANT' default: UNKNOWN readOnly: true x-omitempty: true ResiliencyDetails: $ref: '#/components/schemas/hyperflex.HxResiliencyInfoDt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true State: type: string enum: - 'UNKNOWN' - 'ONLINE' - 'OFFLINE' - 'ENOSPACE' - 'READONLY' default: UNKNOWN readOnly: true x-omitempty: true Uuid: type: string readOnly: true x-omitempty: true ZkHealth: type: string enum: - 'NOT_AVAILABLE' - 'UNKNOWN' - 'ONLINE' - 'OFFLINE' default: NOT_AVAILABLE readOnly: true x-omitempty: true ZoneResiliencyList: type: array items: $ref: '#/components/schemas/hyperflex.HxZoneResiliencyInfoDt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Cluster: # A Relationship to MO hyperflex.Cluster $ref: '#/components/schemas/hyperflex.Cluster.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexCluster resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true hyperflex.Health.List: title: List of 'hyperflex.Health' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.Health' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.Health' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.Health' nullable: true hyperflex.HxLinkDt: title: Hyperflex:Hx Link Dt x-allOf-name: hyperflex.HxLinkDt allOf: - # This 'hyperflex.HxLinkDt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.HxLinkDt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.HxLinkDt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.HxLinkDt' ObjectType: enum: - 'hyperflex.HxLinkDt' Comments: type: string readOnly: true x-omitempty: true Href: type: string readOnly: true x-omitempty: true Method: type: string enum: - 'POST' - 'GET' - 'PUT' - 'DELETE' default: POST readOnly: true x-omitempty: true Rel: type: string readOnly: true x-omitempty: true hyperflex.HxNetworkAddressDt: title: Hyperflex:Hx Network Address Dt x-allOf-name: hyperflex.HxNetworkAddressDt allOf: - # This 'hyperflex.HxNetworkAddressDt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.HxNetworkAddressDt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.HxNetworkAddressDt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.HxNetworkAddressDt' ObjectType: enum: - 'hyperflex.HxNetworkAddressDt' Address: type: string readOnly: true x-omitempty: true Fqdn: type: string readOnly: true x-omitempty: true Ip: type: string readOnly: true x-omitempty: true hyperflex.HxResiliencyInfoDt: title: Hyperflex:Hx Resiliency Info Dt x-allOf-name: hyperflex.HxResiliencyInfoDt allOf: - # This 'hyperflex.HxResiliencyInfoDt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.HxResiliencyInfoDt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.HxResiliencyInfoDt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.HxResiliencyInfoDt' ObjectType: enum: - 'hyperflex.HxResiliencyInfoDt' DataReplicationFactor: type: string enum: - 'ONE_COPY' - 'TWO_COPIES' - 'THREE_COPIES' - 'FOUR_COPIES' - 'SIX_COPIES' default: ONE_COPY readOnly: true x-omitempty: true HddFailuresTolerable: type: integer format: int64 readOnly: true x-omitempty: true Messages: type: array items: type: string readOnly: true x-omitempty: true NodeFailuresTolerable: type: integer format: int64 readOnly: true x-omitempty: true PolicyCompliance: type: string enum: - 'UNKNOWN' - 'COMPLIANT' - 'NON_COMPLIANT' default: UNKNOWN readOnly: true x-omitempty: true ResiliencyState: type: string enum: - 'UNKNOWN' - 'HEALTHY' - 'WARNING' - 'OFFLINE' default: UNKNOWN readOnly: true x-omitempty: true SsdFailuresTolerable: type: integer format: int64 readOnly: true x-omitempty: true hyperflex.HxUuIdDt: title: Hyperflex:Hx Uu Id Dt x-allOf-name: hyperflex.HxUuIdDt allOf: - # This 'hyperflex.HxUuIdDt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.HxUuIdDt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.HxUuIdDt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.HxUuIdDt' ObjectType: enum: - 'hyperflex.HxUuIdDt' Links: type: array items: $ref: '#/components/schemas/hyperflex.HxLinkDt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Uuid: type: string readOnly: true x-omitempty: true hyperflex.HxZoneResiliencyInfoDt: title: Hyperflex:Hx Zone Resiliency Info Dt x-allOf-name: hyperflex.HxZoneResiliencyInfoDt allOf: - # This 'hyperflex.HxZoneResiliencyInfoDt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.HxZoneResiliencyInfoDt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.HxZoneResiliencyInfoDt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.HxZoneResiliencyInfoDt' ObjectType: enum: - 'hyperflex.HxZoneResiliencyInfoDt' Name: type: string readOnly: true x-omitempty: true ResiliencyInfo: $ref: '#/components/schemas/hyperflex.HxResiliencyInfoDt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true hyperflex.HxdpVersion.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.HxdpVersion' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.HxdpVersion' resources. x-one-of-name: hyperflex.HxdpVersion.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.HxdpVersion.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.HxdpVersion.Relationship: description: A relationship to the 'hyperflex.HxdpVersion' resource, or the expanded 'hyperflex.HxdpVersion' resource, or the 'null' value. x-one-of-name: hyperflex.HxdpVersion.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.HxdpVersion' hyperflex.HxdpVersion: title: Hyperflex:Hxdp Version description: |- A HyperFlex Data Platform version. x-allOf-name: hyperflex.HxdpVersion allOf: - # This 'hyperflex.HxdpVersion' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.HxdpVersion' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.HxdpVersion', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.HxdpVersion' ObjectType: enum: - 'hyperflex.HxdpVersion' Version: description: |- The HyperFlex Data Platform version. type: string x-omitempty: true AppCatalog: # A Relationship to MO hyperflex.AppCatalog $ref: '#/components/schemas/hyperflex.AppCatalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAppCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.HxdpVersion.List: title: List of 'hyperflex.HxdpVersion' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.HxdpVersion' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.HxdpVersion' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.HxdpVersion' nullable: true hyperflex.IpAddrRange: title: Hyperflex:Ip Addr Range description: |- A range of IPv4 addresses. The range is inclusive and comprised of a start IP address, an end IP address, netmask, and default gateway. x-allOf-name: hyperflex.IpAddrRange allOf: - # This 'hyperflex.IpAddrRange' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.IpAddrRange' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.IpAddrRange', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.IpAddrRange' ObjectType: enum: - 'hyperflex.IpAddrRange' EndAddr: description: |- The end IPv4 address of the range. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true Gateway: description: |- The default gateway for the start and end IPv4 addresses. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true Netmask: description: |- The netmask specified in dot decimal notation. The start address, end address, and gateway must all be within the network specified by this netmask. type: string pattern: "^$|^(((255\\.){3}(255|254|252|248|240|224|192|128|0+))|((255\\.){2}(255|254|252|248|240|224|192|128|0+)\\.0)|((255\\.)(255|254|252|248|240|224|192|128|0+)(\\.0+){2})|((255|254|252|248|240|224|192|128|0+)(\\.0+){3}))$" x-omitempty: true StartAddr: description: |- The start IPv4 address of the range. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true hyperflex.LocalCredentialPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.LocalCredentialPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.LocalCredentialPolicy' resources. x-one-of-name: hyperflex.LocalCredentialPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.LocalCredentialPolicy.Relationship: description: A relationship to the 'hyperflex.LocalCredentialPolicy' resource, or the expanded 'hyperflex.LocalCredentialPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.LocalCredentialPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' hyperflex.LocalCredentialPolicy: title: Security description: |- A policy specifying credentials for HyperFlex cluster such as controller VM password, hypervisor username, and password. x-allOf-name: hyperflex.LocalCredentialPolicy allOf: - # This 'hyperflex.LocalCredentialPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.LocalCredentialPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.LocalCredentialPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.LocalCredentialPolicy' ObjectType: enum: - 'hyperflex.LocalCredentialPolicy' FactoryHypervisorPassword: description: |- Indicates if Hypervisor password is the factory set default password. For HyperFlex Data Platform versions 3.0 or higher, enable this if the default password was not changed on the Hypervisor. It is required to supply a new custom Hypervisor password that will be applied to the Hypervisor during deployment. For HyperFlex Data Platform versions prior to 3.0 release, this setting has no effect and the default password will be used for initial install. The Hypervisor password should be changed after deployment. type: boolean x-omitempty: true HxdpRootPwd: description: |- HyperFlex storage controller VM password must contain a minimum of 10 characters, with at least 1 lowercase, 1 uppercase, 1 numeric, and 1 of these -_@#$%^&*! special characters. type: string pattern: "^[a-zA-Z0-9!@#$%^&*_-]{10,}$" writeOnly: true x-omitempty: true HypervisorAdmin: description: |- Hypervisor administrator username must contain only alphanumeric characters. Use the root account for ESXi deployments. type: string pattern: "^[a-zA-Z0-9]{1,}$" x-omitempty: true HypervisorAdminPwd: description: |- The ESXi root password. For HyperFlex Data Platform 3.0 or later, if the factory default password was not manually changed, you must set a new custom password. If the password was manually changed, you must not enable the factory default password property and provide the current hypervisor password. Note - All HyperFlex nodes require the same hypervisor password for installation. For HyperFlex Data Platform prior to 3.0, use the default password "Cisco123" for newly manufactured HyperFlex servers. A custom password should only be entered if hypervisor credentials were manually changed prior to deployment. type: string pattern: "^.{7,40}$" writeOnly: true x-omitempty: true IsHxdpRootPwdSet: description: |- Indicates whether the value of the 'hxdpRootPwd' property has been set. type: boolean readOnly: true x-omitempty: true IsHypervisorAdminPwdSet: description: |- Indicates whether the value of the 'hypervisorAdminPwd' property has been set. type: boolean readOnly: true x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.LocalCredentialPolicy.List: title: List of 'hyperflex.LocalCredentialPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.LocalCredentialPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.LocalCredentialPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.LocalCredentialPolicy' nullable: true hyperflex.LogicalAvailabilityZone: title: Hyperflex:Logical Availability Zone description: |- A configuration for the Logical Availability Zone. Logical Availability Zones (LAZ) allow for increased fault tolerance by dividing clusters into logical partitions where a given block of data is only written to a zone once. This allows replications of data to be distributed evenly across zones. LAZ configurations are compatible with HyperFlex clusters meeting all of the following criteria: 1. The HyperFlex cluster must be attached to a UCS Fabric Interconnect. 2. The HyperFlex cluster must be running HyperFlex Data Platform 3.0 or higher. 3. The HyperFlex cluster must have 8 or more converged nodes. x-allOf-name: hyperflex.LogicalAvailabilityZone allOf: - # This 'hyperflex.LogicalAvailabilityZone' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.LogicalAvailabilityZone' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.LogicalAvailabilityZone', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.LogicalAvailabilityZone' ObjectType: enum: - 'hyperflex.LogicalAvailabilityZone' AutoConfig: description: |- Enable or disable Logical Availability Zones (LAZ). If enabled, HyperFlex Data Platform automatically selects and groups nodes into different availability zones. For HyperFlex Data Platform versions prior to 3.0 release, this setting does not apply. For HyperFlex Data Platform versions 3.0 or higher, this setting is only applicable to Fabric Interconnect attached HyperFlex systems with 8 or more converged nodes. type: boolean x-omitempty: true hyperflex.MacAddrPrefixRange: title: Hyperflex:Mac Addr Prefix Range description: |- A MAC address prefix range. The range is inclusive and comprised of a start and end MAC addresses. A single address can be specified by setting it as the start and end of the range. x-allOf-name: hyperflex.MacAddrPrefixRange allOf: - # This 'hyperflex.MacAddrPrefixRange' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.MacAddrPrefixRange' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.MacAddrPrefixRange', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.MacAddrPrefixRange' ObjectType: enum: - 'hyperflex.MacAddrPrefixRange' EndAddr: description: |- The end MAC address prefix of a MAC address prefix range in the form of 00:25:B5:XX. type: string pattern: "^$|^00:25:B5:[0-9a-fA-F]{2}$" x-omitempty: true StartAddr: description: |- The start MAC address prefix of a MAC address prefix range in the form of 00:25:B5:XX. type: string pattern: "^$|^00:25:B5:[0-9a-fA-F]{2}$" x-omitempty: true hyperflex.NamedVlan: title: Hyperflex:Named Vlan description: |- A VLAN with a name and ID. Named VLANs are used for defining the network and iSCSI external storage policies for the cluster. x-allOf-name: hyperflex.NamedVlan allOf: - # This 'hyperflex.NamedVlan' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.NamedVlan' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.NamedVlan', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.NamedVlan' ObjectType: enum: - 'hyperflex.NamedVlan' Name: description: |- The name of the VLAN. The name can be from 1 to 32 characters long and can contain a combination of alphanumeric characters, underscores, and hyphens. type: string pattern: "^$|^[a-zA-Z0-9-_.]{1,32}$" x-omitempty: true VlanId: description: |- The ID of the named VLAN. An ID of 0 means the traffic is untagged. The ID can be any number between 0 and 4095, inclusive. type: integer format: int64 minimum: 0 maximum: 4095 x-omitempty: true hyperflex.NamedVsan: title: Hyperflex:Named Vsan description: |- A VSAN with a name and ID. VSANs are used when defining Fibre Channel external storage policies for the cluster. x-allOf-name: hyperflex.NamedVsan allOf: - # This 'hyperflex.NamedVsan' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.NamedVsan' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.NamedVsan', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.NamedVsan' ObjectType: enum: - 'hyperflex.NamedVsan' Name: description: |- The name of the VSAN. The name can be from 1 to 32 characters long and can contain a combination of alphanumeric characters, underscores, and hyphens. type: string pattern: "^$|^[a-zA-Z0-9-_.]{1,32}$" x-omitempty: true VsanId: description: |- The ID of the named VSAN. The ID can be any number between 1 and 4093, inclusive. type: integer format: int64 minimum: 1 maximum: 4093 x-omitempty: true hyperflex.Node.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.Node' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.Node' resources. x-one-of-name: hyperflex.Node.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.Node.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.Node.Relationship: description: A relationship to the 'hyperflex.Node' resource, or the expanded 'hyperflex.Node' resource, or the 'null' value. x-one-of-name: hyperflex.Node.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.Node' hyperflex.Node: title: Hyperflex:Node x-allOf-name: hyperflex.Node allOf: - # This 'hyperflex.Node' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.Node' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.Node', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.Node' ObjectType: enum: - 'hyperflex.Node' BuildNumber: type: string readOnly: true x-omitempty: true DisplayVersion: type: string readOnly: true x-omitempty: true HostName: type: string readOnly: true x-omitempty: true Hypervisor: type: string readOnly: true x-omitempty: true Identity: $ref: '#/components/schemas/hyperflex.HxUuIdDt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Ip: $ref: '#/components/schemas/hyperflex.HxNetworkAddressDt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Lockdown: type: boolean readOnly: true x-omitempty: true ModelNumber: type: string readOnly: true x-omitempty: true Role: type: string enum: - 'UNKNOWN' - 'STORAGE' - 'COMPUTE' default: UNKNOWN readOnly: true x-omitempty: true SerialNumber: type: string readOnly: true x-omitempty: true Status: type: string enum: - 'UNKNOWN' - 'ONLINE' - 'OFFLINE' - 'INMAINTENANCE' - 'DEGRADED' default: UNKNOWN readOnly: true x-omitempty: true Version: type: string readOnly: true x-omitempty: true Cluster: # A Relationship to MO hyperflex.Cluster $ref: '#/components/schemas/hyperflex.Cluster.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexCluster resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ClusterMember: # A Relationship to MO asset.ClusterMember $ref: '#/components/schemas/asset.ClusterMember.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetClusterMember resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalServer: # A Relationship to MO compute.Physical $ref: '#/components/schemas/compute.Physical.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computePhysical resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true hyperflex.Node.List: title: List of 'hyperflex.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 'hyperflex.Node' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.Node' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.Node' nullable: true hyperflex.NodeConfigPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.NodeConfigPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.NodeConfigPolicy' resources. x-one-of-name: hyperflex.NodeConfigPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.NodeConfigPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.NodeConfigPolicy.Relationship: description: A relationship to the 'hyperflex.NodeConfigPolicy' resource, or the expanded 'hyperflex.NodeConfigPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.NodeConfigPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' hyperflex.NodeConfigPolicy: title: Node IP and Hostname description: |- A policy specifying node details such as management and storage data IP ranges. For HyperFlex Edge, storage data IP range is pre-defined. x-allOf-name: hyperflex.NodeConfigPolicy allOf: - # This 'hyperflex.NodeConfigPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.NodeConfigPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.NodeConfigPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.NodeConfigPolicy' ObjectType: enum: - 'hyperflex.NodeConfigPolicy' DataIpRange: description: |- The range of storage data IPs to be assigned to the nodes. $ref: '#/components/schemas/hyperflex.IpAddrRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true HxdpIpRange: description: |- The range of storage management IPs to be assigned to the nodes. $ref: '#/components/schemas/hyperflex.IpAddrRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MgmtIpRange: description: |- The range of management IPs to be assigned to the nodes. $ref: '#/components/schemas/hyperflex.IpAddrRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true NodeNamePrefix: description: |- The node name prefix that is used to automatically generate the default hostname for each server. A dash (-) will be appended to the prefix followed by the node number to form a hostname. This default naming scheme can be manually overridden in the node configuration. The maximum length of a prefix is 60, must only contain alphanumeric characters or dash (-), and must start with an alphanumeric character. type: string pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]{1,59}$" x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.NodeConfigPolicy.List: title: List of 'hyperflex.NodeConfigPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.NodeConfigPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.NodeConfigPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.NodeConfigPolicy' nullable: true hyperflex.NodeProfile.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.NodeProfile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.NodeProfile' resources. x-one-of-name: hyperflex.NodeProfile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.NodeProfile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.NodeProfile.Relationship: description: A relationship to the 'hyperflex.NodeProfile' resource, or the expanded 'hyperflex.NodeProfile' resource, or the 'null' value. x-one-of-name: hyperflex.NodeProfile.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.NodeProfile' hyperflex.NodeProfile: title: Hyperflex:Node Profile description: |- A configuration profile per node in the HyperFlex cluster. It defines node settings such as IP address configuration for hypervisor management network, storage data network, HyperFlex management network, and the assigned physical server. x-allOf-name: hyperflex.NodeProfile allOf: - # This 'hyperflex.NodeProfile' class inherits all properties from its parent class policy.AbstractProfile. $ref: '#/components/schemas/policy.AbstractProfile' - # The definition of all the properties specified in this 'hyperflex.NodeProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.NodeProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.NodeProfile' ObjectType: enum: - 'hyperflex.NodeProfile' HxdpDataIp: description: |- IP address for storage data network (Controller VM interface). 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true HxdpMgmtIp: description: |- IP address for HyperFlex management network. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true HypervisorDataIp: description: |- IP address for storage data network (Hypervisor interface). 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true HypervisorMgmtIp: description: |- IP address for Hypervisor management network. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true AssignedServer: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. ClusterProfile: # A Relationship to MO hyperflex.ClusterProfile $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexClusterProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.NodeProfile.List: title: List of 'hyperflex.NodeProfile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.NodeProfile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.NodeProfile' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.NodeProfile' nullable: true hyperflex.ProxySettingPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ProxySettingPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ProxySettingPolicy' resources. x-one-of-name: hyperflex.ProxySettingPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ProxySettingPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ProxySettingPolicy.Relationship: description: A relationship to the 'hyperflex.ProxySettingPolicy' resource, or the expanded 'hyperflex.ProxySettingPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.ProxySettingPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' hyperflex.ProxySettingPolicy: title: HTTP Proxy description: |- A policy specifying the HTTP proxy settings to be used by the HyperFlex installation process and HyperFlex storage controller VMs. This policy is required when the internet access of your servers including CIMC and HyperFlex storage controller VMs is secured by a HTTP proxy. x-allOf-name: hyperflex.ProxySettingPolicy allOf: - # This 'hyperflex.ProxySettingPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.ProxySettingPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ProxySettingPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ProxySettingPolicy' ObjectType: enum: - 'hyperflex.ProxySettingPolicy' Hostname: description: |- HTTP Proxy server FQDN or IP. type: string pattern: "^[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?$|^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)*(\\.[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$|^([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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Password: description: |- The password for the HTTP Proxy. type: string writeOnly: true x-omitempty: true Port: description: |- The HTTP Proxy port number. The port number of the HTTP proxy must be between 1 and 65535, inclusive. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true Username: description: |- The username for the HTTP Proxy. type: string x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.ProxySettingPolicy.List: title: List of 'hyperflex.ProxySettingPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ProxySettingPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ProxySettingPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ProxySettingPolicy' nullable: true hyperflex.ServerFirmwareVersion.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ServerFirmwareVersion' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ServerFirmwareVersion' resources. x-one-of-name: hyperflex.ServerFirmwareVersion.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ServerFirmwareVersion.Relationship: description: A relationship to the 'hyperflex.ServerFirmwareVersion' resource, or the expanded 'hyperflex.ServerFirmwareVersion' resource, or the 'null' value. x-one-of-name: hyperflex.ServerFirmwareVersion.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' hyperflex.ServerFirmwareVersion: title: Hyperflex:Server Firmware Version description: |- A server firmware bundle version used for server components such as CIMC, adapters, BIOS, etc. x-allOf-name: hyperflex.ServerFirmwareVersion allOf: - # This 'hyperflex.ServerFirmwareVersion' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.ServerFirmwareVersion' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ServerFirmwareVersion', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ServerFirmwareVersion' ObjectType: enum: - 'hyperflex.ServerFirmwareVersion' ServerFirmwareVersionEntries: type: array items: description: |- A list of server firmware bundle versions used for server components such as CIMC, adapters, BIOS, etc. $ref: '#/components/schemas/hyperflex.ServerFirmwareVersionEntry' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AppCatalog: # A Relationship to MO hyperflex.AppCatalog $ref: '#/components/schemas/hyperflex.AppCatalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAppCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.ServerFirmwareVersion.List: title: List of 'hyperflex.ServerFirmwareVersion' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ServerFirmwareVersion' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ServerFirmwareVersion' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ServerFirmwareVersion' nullable: true hyperflex.ServerFirmwareVersionEntry: title: Hyperflex:Server Firmware Version Entry description: |- A server firmware bundle version used for server components such as CIMC, adapters, BIOS, etc. x-allOf-name: hyperflex.ServerFirmwareVersionEntry allOf: - # This 'hyperflex.ServerFirmwareVersionEntry' class inherits all properties from its parent class hyperflex.AbstractAppSetting. $ref: '#/components/schemas/hyperflex.AbstractAppSetting' - # The definition of all the properties specified in this 'hyperflex.ServerFirmwareVersionEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ServerFirmwareVersionEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ServerFirmwareVersionEntry' ObjectType: enum: - 'hyperflex.ServerFirmwareVersionEntry' Constraint: description: |- The conditions that must be satisfied before applying the AppSetting. $ref: '#/components/schemas/hyperflex.AppSettingConstraint' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Label: description: |- The display name for server firmware bundle version in UI. type: string x-omitempty: true hyperflex.ServerModel.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.ServerModel' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.ServerModel' resources. x-one-of-name: hyperflex.ServerModel.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.ServerModel.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.ServerModel.Relationship: description: A relationship to the 'hyperflex.ServerModel' resource, or the expanded 'hyperflex.ServerModel' resource, or the 'null' value. x-one-of-name: hyperflex.ServerModel.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.ServerModel' hyperflex.ServerModel: title: Hyperflex:Server Model description: |- A supported server model. x-allOf-name: hyperflex.ServerModel allOf: - # This 'hyperflex.ServerModel' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'hyperflex.ServerModel' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ServerModel', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ServerModel' ObjectType: enum: - 'hyperflex.ServerModel' ServerModelEntries: type: array items: description: |- The supported server models in regex format. $ref: '#/components/schemas/hyperflex.ServerModelEntry' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AppCatalog: # A Relationship to MO hyperflex.AppCatalog $ref: '#/components/schemas/hyperflex.AppCatalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexAppCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. hyperflex.ServerModel.List: title: List of 'hyperflex.ServerModel' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.ServerModel' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.ServerModel' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.ServerModel' nullable: true hyperflex.ServerModelEntry: title: Hyperflex:Server Model Entry description: |- A constraint specifying supported server models in regex format. x-allOf-name: hyperflex.ServerModelEntry allOf: - # This 'hyperflex.ServerModelEntry' class inherits all properties from its parent class hyperflex.AbstractAppSetting. $ref: '#/components/schemas/hyperflex.AbstractAppSetting' - # The definition of all the properties specified in this 'hyperflex.ServerModelEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.ServerModelEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.ServerModelEntry' ObjectType: enum: - 'hyperflex.ServerModelEntry' Constraint: description: |- The conditions that must be satisfied before applying the AppSetting. $ref: '#/components/schemas/hyperflex.AppSettingConstraint' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true hyperflex.SoftwareVersionPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.SoftwareVersionPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.SoftwareVersionPolicy' resources. x-one-of-name: hyperflex.SoftwareVersionPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.SoftwareVersionPolicy.Relationship: description: A relationship to the 'hyperflex.SoftwareVersionPolicy' resource, or the expanded 'hyperflex.SoftwareVersionPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.SoftwareVersionPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' hyperflex.SoftwareVersionPolicy: title: HyperFlex Software Version Selection Policy description: |- A policy capturing software versions for different HyperFlex Cluster compatible components ( like HyperFlex Data Platform, Hypervisor, etc. ), that the user wishes to apply on the HyperFlex cluster. x-allOf-name: hyperflex.SoftwareVersionPolicy allOf: - # This 'hyperflex.SoftwareVersionPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.SoftwareVersionPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.SoftwareVersionPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.SoftwareVersionPolicy' ObjectType: enum: - 'hyperflex.SoftwareVersionPolicy' HxdpVersion: description: |- Desired HyperFlex Data Platform software version to apply on the HyperFlex cluster. type: string x-omitempty: true HypervisorVersion: description: |- Desired hypervisor version to apply for all the nodes on the HyperFlex cluster. type: string x-omitempty: true ServerFirmwareVersion: description: |- Desired server firmware version to apply on the HyperFlex Cluster. type: string pattern: "^$|(^3\\.[1-9]\\([1-9][a-z]\\)$|^[4-9]\\.[1-9]\\([1-9][a-z]\\)$|^4\\.0\\([1-3][a-z]\\)$|^4\\.0\\(4[d-z]\\)$|4\\.0\\([5-9][a-z]\\)$)" x-omitempty: true UpgradeTypes: type: array items: description: |- List of components to be upgraded on the HyperFlex Cluster. * `NONE` - Default UpgradeType set to NONE. * `Hxdp` - UpgradeType used when HyperFlex data platform needs to be upgraded. * `Hypervisor` - UpgradeType used when HyperVisor (ESXi/Hyperv) needs to be upgraded. type: string enum: - 'NONE' - 'Hxdp' - 'Hypervisor' default: NONE x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true HxdpVersionInfo: # A Relationship to MO software.HyperflexDistributable $ref: '#/components/schemas/software.HyperflexDistributable.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwareHyperflexDistributable resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true HypervisorVersionInfo: # A Relationship to MO software.HyperflexDistributable $ref: '#/components/schemas/software.HyperflexDistributable.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwareHyperflexDistributable resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true ServerFirmwareVersionInfo: # A Relationship to MO firmware.Distributable $ref: '#/components/schemas/firmware.Distributable.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareDistributable resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true hyperflex.SoftwareVersionPolicy.List: title: List of 'hyperflex.SoftwareVersionPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.SoftwareVersionPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.SoftwareVersionPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.SoftwareVersionPolicy' nullable: true hyperflex.StPlatformClusterHealingInfo: title: Hyperflex:St Platform Cluster Healing Info x-allOf-name: hyperflex.StPlatformClusterHealingInfo allOf: - # This 'hyperflex.StPlatformClusterHealingInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.StPlatformClusterHealingInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.StPlatformClusterHealingInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.StPlatformClusterHealingInfo' ObjectType: enum: - 'hyperflex.StPlatformClusterHealingInfo' EstimatedCompletionTimeInSeconds: type: integer format: int64 readOnly: true x-omitempty: true InProgress: type: boolean readOnly: true x-omitempty: true Messages: type: array items: type: string readOnly: true x-omitempty: true MessagesIterator: readOnly: true # Property is any value, it may be the null value, an object or array. x-omitempty: true MessagesSize: type: integer format: int64 readOnly: true x-omitempty: true PercentComplete: type: integer format: int64 readOnly: true x-omitempty: true hyperflex.StPlatformClusterResiliencyInfo: title: Hyperflex:St Platform Cluster Resiliency Info x-allOf-name: hyperflex.StPlatformClusterResiliencyInfo allOf: - # This 'hyperflex.StPlatformClusterResiliencyInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.StPlatformClusterResiliencyInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.StPlatformClusterResiliencyInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.StPlatformClusterResiliencyInfo' ObjectType: enum: - 'hyperflex.StPlatformClusterResiliencyInfo' HddFailuresTolerable: type: integer format: int64 readOnly: true x-omitempty: true Messages: type: array items: type: string readOnly: true x-omitempty: true MessagesIterator: readOnly: true # Property is any value, it may be the null value, an object or array. x-omitempty: true MessagesSize: type: integer format: int64 readOnly: true x-omitempty: true NodeFailuresTolerable: type: integer format: int64 readOnly: true x-omitempty: true SsdFailuresTolerable: type: integer format: int64 readOnly: true x-omitempty: true State: type: string readOnly: true x-omitempty: true hyperflex.Summary: title: Hyperflex:Summary x-allOf-name: hyperflex.Summary allOf: - # This 'hyperflex.Summary' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.Summary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.Summary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.Summary' ObjectType: enum: - 'hyperflex.Summary' ActiveNodes: type: string readOnly: true x-omitempty: true Address: type: string readOnly: true x-omitempty: true Boottime: type: integer format: int64 readOnly: true x-omitempty: true ClusterAccessPolicy: type: string readOnly: true x-omitempty: true CompressionSavings: type: number format: double readOnly: true x-omitempty: true DataReplicationCompliance: type: string readOnly: true x-omitempty: true DataReplicationFactor: type: string readOnly: true x-omitempty: true DeduplicationSavings: type: number format: double readOnly: true x-omitempty: true Downtime: type: string readOnly: true x-omitempty: true FreeCapacity: type: integer format: int64 readOnly: true x-omitempty: true HealingInfo: $ref: '#/components/schemas/hyperflex.StPlatformClusterHealingInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Name: type: string readOnly: true x-omitempty: true ResiliencyDetails: type: object readOnly: true x-omitempty: true ResiliencyDetailsSize: type: integer format: int64 readOnly: true x-omitempty: true ResiliencyInfo: $ref: '#/components/schemas/hyperflex.StPlatformClusterResiliencyInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true SpaceStatus: type: string readOnly: true x-omitempty: true State: type: string readOnly: true x-omitempty: true TotalCapacity: type: integer format: int64 readOnly: true x-omitempty: true TotalSavings: type: number format: double readOnly: true x-omitempty: true Uptime: type: string readOnly: true x-omitempty: true UsedCapacity: type: integer format: int64 readOnly: true x-omitempty: true hyperflex.SysConfigPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.SysConfigPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.SysConfigPolicy' resources. x-one-of-name: hyperflex.SysConfigPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.SysConfigPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.SysConfigPolicy.Relationship: description: A relationship to the 'hyperflex.SysConfigPolicy' resource, or the expanded 'hyperflex.SysConfigPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.SysConfigPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.SysConfigPolicy' hyperflex.SysConfigPolicy: title: DNS, NTP and Timezone description: |- A policy specifying system configuration such as timezone, DNS servers, and NTP Servers. x-allOf-name: hyperflex.SysConfigPolicy allOf: - # This 'hyperflex.SysConfigPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.SysConfigPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.SysConfigPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.SysConfigPolicy' ObjectType: enum: - 'hyperflex.SysConfigPolicy' DnsDomainName: description: |- The DNS Search Domain Name. This setting applies to HyperFlex Data Platform 3.0 or later only. type: string pattern: "^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" minLength: 0 maxLength: 253 x-omitempty: true DnsServers: type: array items: description: |- Enter between 1 and 3 DNS servers. A DNS server that can resolve public domains is required for Intersight management. 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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true minItems: 1 maxItems: 3 NtpServers: type: array items: description: |- Enter between 1 and 3 NTP servers (IP address or FQDN). A local NTP server is highly recommended. type: string pattern: "^$|^[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?$|^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)*(\\.[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$|^([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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true minItems: 1 maxItems: 3 Timezone: description: "The timezone of the HyperFlex cluster's system clock.\n* `Pacific/Niue` - \n* `Pacific/Pago_Pago` - \n* `Pacific/Honolulu` - \n* `Pacific/Rarotonga` - \n* `Pacific/Tahiti` - \n* `Pacific/Marquesas` - \n* `America/Anchorage` - \n* `Pacific/Gambier` - \n* `America/Los_Angeles` - \n* `America/Tijuana` - \n* `America/Vancouver` - \n* `America/Whitehorse` - \n* `Pacific/Pitcairn` - \n* `America/Dawson_Creek` - \n* `America/Denver` - \n* `America/Edmonton` - \n* `America/Hermosillo` - \n* `America/Mazatlan` - \n* `America/Phoenix` - \n* `America/Yellowknife` - \n* `America/Belize` - \n* `America/Chicago` - \n* `America/Costa_Rica` - \n* `America/El_Salvador` - \n* `America/Guatemala` - \n* `America/Managua` - \n* `America/Mexico_City` - \n* `America/Regina` - \n* `America/Tegucigalpa` - \n* `America/Winnipeg` - \n* `Pacific/Galapagos` - \n* `America/Bogota` - \n* `America/Cancun` - \n* `America/Cayman` - \n* `America/Guayaquil` - \n* `America/Havana` - \n* `America/Iqaluit` - \n* `America/Jamaica` - \n* `America/Lima` - \n* `America/Nassau` - \n* `America/New_York` - \n* `America/Panama` - \n* `America/Port-au-Prince` - \n* `America/Rio_Branco` - \n* `America/Toronto` - \n* `Pacific/Easter` - \n* `America/Caracas` - \n* `America/Asuncion` - \n* `America/Barbados` - \n* `America/Boa_Vista` - \n* `America/Campo_Grande` - \n* `America/Cuiaba` - \n* `America/Curacao` - \n* `America/Grand_Turk` - \n* `America/Guyana` - \n* `America/Halifax` - \n* `America/La_Paz` - \n* `America/Manaus` - \n* `America/Martinique` - \n* `America/Port_of_Spain` - \n* `America/Porto_Velho` - \n* `America/Puerto_Rico` - \n* `America/Santo_Domingo` - \n* `America/Thule` - \n* `Atlantic/Bermuda` - \n* `America/St_Johns` - \n* `America/Araguaina` - \n* `America/Argentina/Buenos_Aires` - \n* `America/Bahia` - \n* `America/Belem` - \n* `America/Cayenne` - \n* `America/Fortaleza` - \n* `America/Godthab` - \n* `America/Maceio` - \n* `America/Miquelon` - \n* `America/Montevideo` - \n* `America/Paramaribo` - \n* `America/Recife` - \n* `America/Santiago` - \n* `America/Sao_Paulo` - \n* `Antarctica/Palmer` - \n* `Antarctica/Rothera` - \n* `Atlantic/Stanley` - \n* `America/Noronha` - \n* `Atlantic/South_Georgia` - \n* `America/Scoresbysund` - \n* `Atlantic/Azores` - \n* `Atlantic/Cape_Verde` - \n* `Africa/Abidjan` - \n* `Africa/Accra` - \n* `Africa/Bissau` - \n* `Africa/Casablanca` - \n* `Africa/El_Aaiun` - \n* `Africa/Monrovia` - \n* `America/Danmarkshavn` - \n* `Atlantic/Canary` - \n* `Atlantic/Faroe` - \n* `Atlantic/Reykjavik` - \n* `Etc/GMT` - \n* `Europe/Dublin` - \n* `Europe/Lisbon` - \n* `Europe/London` - \n* `Africa/Algiers` - \n* `Africa/Ceuta` - \n* `Africa/Lagos` - \n* `Africa/Ndjamena` - \n* `Africa/Tunis` - \n* `Africa/Windhoek` - \n* `Europe/Amsterdam` - \n* `Europe/Andorra` - \n* `Europe/Belgrade` - \n* `Europe/Berlin` - \n* `Europe/Brussels` - \n* `Europe/Budapest` - \n* `Europe/Copenhagen` - \n* `Europe/Gibraltar` - \n* `Europe/Luxembourg` - \n* `Europe/Madrid` - \n* `Europe/Malta` - \n* `Europe/Monaco` - \n* `Europe/Oslo` - \n* `Europe/Paris` - \n* `Europe/Prague` - \n* `Europe/Rome` - \n* `Europe/Stockholm` - \n* `Europe/Tirane` - \n* `Europe/Vienna` - \n* `Europe/Warsaw` - \n* `Europe/Zurich` - \n* `Africa/Cairo` - \n* `Africa/Johannesburg` - \n* `Africa/Maputo` - \n* `Africa/Tripoli` - \n* `Asia/Amman` - \n* `Asia/Beirut` - \n* `Asia/Damascus` - \n* `Asia/Gaza` - \n* `Asia/Jerusalem` - \n* `Asia/Nicosia` - \n* `Europe/Athens` - \n* `Europe/Bucharest` - \n* `Europe/Chisinau` - \n* `Europe/Helsinki` - \n* `Europe/Istanbul` - \n* `Europe/Kaliningrad` - \n* `Europe/Kiev` - \n* `Europe/Riga` - \n* `Europe/Sofia` - \n* `Europe/Tallinn` - \n* `Europe/Vilnius` - \n* `Africa/Khartoum` - \n* `Africa/Nairobi` - \n* `Antarctica/Syowa` - \n* `Asia/Baghdad` - \n* `Asia/Qatar` - \n* `Asia/Riyadh` - \n* `Europe/Minsk` - \n* `Europe/Moscow` - \n* `Asia/Tehran` - \n* `Asia/Baku` - \n* `Asia/Dubai` - \n* `Asia/Tbilisi` - \n* `Asia/Yerevan` - \n* `Europe/Samara` - \n* `Indian/Mahe` - \n* `Indian/Mauritius` - \n* `Indian/Reunion` - \n* `Asia/Kabul` - \n* `Antarctica/Mawson` - \n* `Asia/Aqtau` - \n* `Asia/Aqtobe` - \n* `Asia/Ashgabat` - \n* `Asia/Dushanbe` - \n* `Asia/Karachi` - \n* `Asia/Tashkent` - \n* `Asia/Yekaterinburg` - \n* `Indian/Kerguelen` - \n* `Indian/Maldives` - \n* `Asia/Calcutta` - \n* `Asia/Kolkata` - \n* `Asia/Colombo` - \n* `Asia/Katmandu` - \n* `Antarctica/Vostok` - \n* `Asia/Almaty` - \n* `Asia/Bishkek` - \n* `Asia/Dhaka` - \n* `Asia/Omsk` - \n* `Asia/Thimphu` - \n* `Indian/Chagos` - \n* `Asia/Rangoon` - \n* `Indian/Cocos` - \n* `Antarctica/Davis` - \n* `Asia/Bangkok` - \n* `Asia/Hovd` - \n* `Asia/Jakarta` - \n* `Asia/Krasnoyarsk` - \n* `Asia/Saigon` - \n* `Indian/Christmas` - \n* `Antarctica/Casey` - \n* `Asia/Brunei` - \n* `Asia/Choibalsan` - \n* `Asia/Hong_Kong` - \n* `Asia/Irkutsk` - \n* `Asia/Kuala_Lumpur` - \n* `Asia/Macau` - \n* `Asia/Makassar` - \n* `Asia/Manila` - \n* `Asia/Shanghai` - \n* `Asia/Singapore` - \n* `Asia/Taipei` - \n* `Asia/Ulaanbaatar` - \n* `Australia/Perth` - \n* `Asia/Pyongyang` - \n* `Asia/Dili` - \n* `Asia/Jayapura` - \n* `Asia/Seoul` - \n* `Asia/Tokyo` - \n* `Asia/Yakutsk` - \n* `Pacific/Palau` - \n* `Australia/Adelaide` - \n* `Australia/Darwin` - \n* `Antarctica/DumontDUrville` - \n* `Asia/Magadan` - \n* `Asia/Vladivostok` - \n* `Australia/Brisbane` - \n* `Australia/Hobart` - \n* `Australia/Sydney` - \n* `Pacific/Chuuk` - \n* `Pacific/Guam` - \n* `Pacific/Port_Moresby` - \n* `Pacific/Efate` - \n* `Pacific/Guadalcanal` - \n* `Pacific/Kosrae` - \n* `Pacific/Norfolk` - \n* `Pacific/Noumea` - \n* `Pacific/Pohnpei` - \n* `Asia/Kamchatka` - \n* `Pacific/Auckland` - \n* `Pacific/Fiji` - \n* `Pacific/Funafuti` - \n* `Pacific/Kwajalein` - \n* `Pacific/Majuro` - \n* `Pacific/Nauru` - \n* `Pacific/Tarawa` - \n* `Pacific/Wake` - \n* `Pacific/Wallis` - \n* `Pacific/Apia` - \n* `Pacific/Enderbury` - \n* `Pacific/Fakaofo` - \n* `Pacific/Tongatapu` - \n* `Pacific/Kiritimati` -" type: string enum: - 'Pacific/Niue' - 'Pacific/Pago_Pago' - 'Pacific/Honolulu' - 'Pacific/Rarotonga' - 'Pacific/Tahiti' - 'Pacific/Marquesas' - 'America/Anchorage' - 'Pacific/Gambier' - 'America/Los_Angeles' - 'America/Tijuana' - 'America/Vancouver' - 'America/Whitehorse' - 'Pacific/Pitcairn' - 'America/Dawson_Creek' - 'America/Denver' - 'America/Edmonton' - 'America/Hermosillo' - 'America/Mazatlan' - 'America/Phoenix' - 'America/Yellowknife' - 'America/Belize' - 'America/Chicago' - 'America/Costa_Rica' - 'America/El_Salvador' - 'America/Guatemala' - 'America/Managua' - 'America/Mexico_City' - 'America/Regina' - 'America/Tegucigalpa' - 'America/Winnipeg' - 'Pacific/Galapagos' - 'America/Bogota' - 'America/Cancun' - 'America/Cayman' - 'America/Guayaquil' - 'America/Havana' - 'America/Iqaluit' - 'America/Jamaica' - 'America/Lima' - 'America/Nassau' - 'America/New_York' - 'America/Panama' - 'America/Port-au-Prince' - 'America/Rio_Branco' - 'America/Toronto' - 'Pacific/Easter' - 'America/Caracas' - 'America/Asuncion' - 'America/Barbados' - 'America/Boa_Vista' - 'America/Campo_Grande' - 'America/Cuiaba' - 'America/Curacao' - 'America/Grand_Turk' - 'America/Guyana' - 'America/Halifax' - 'America/La_Paz' - 'America/Manaus' - 'America/Martinique' - 'America/Port_of_Spain' - 'America/Porto_Velho' - 'America/Puerto_Rico' - 'America/Santo_Domingo' - 'America/Thule' - 'Atlantic/Bermuda' - 'America/St_Johns' - 'America/Araguaina' - 'America/Argentina/Buenos_Aires' - 'America/Bahia' - 'America/Belem' - 'America/Cayenne' - 'America/Fortaleza' - 'America/Godthab' - 'America/Maceio' - 'America/Miquelon' - 'America/Montevideo' - 'America/Paramaribo' - 'America/Recife' - 'America/Santiago' - 'America/Sao_Paulo' - 'Antarctica/Palmer' - 'Antarctica/Rothera' - 'Atlantic/Stanley' - 'America/Noronha' - 'Atlantic/South_Georgia' - 'America/Scoresbysund' - 'Atlantic/Azores' - 'Atlantic/Cape_Verde' - 'Africa/Abidjan' - 'Africa/Accra' - 'Africa/Bissau' - 'Africa/Casablanca' - 'Africa/El_Aaiun' - 'Africa/Monrovia' - 'America/Danmarkshavn' - 'Atlantic/Canary' - 'Atlantic/Faroe' - 'Atlantic/Reykjavik' - 'Etc/GMT' - 'Europe/Dublin' - 'Europe/Lisbon' - 'Europe/London' - 'Africa/Algiers' - 'Africa/Ceuta' - 'Africa/Lagos' - 'Africa/Ndjamena' - 'Africa/Tunis' - 'Africa/Windhoek' - 'Europe/Amsterdam' - 'Europe/Andorra' - 'Europe/Belgrade' - 'Europe/Berlin' - 'Europe/Brussels' - 'Europe/Budapest' - 'Europe/Copenhagen' - 'Europe/Gibraltar' - 'Europe/Luxembourg' - 'Europe/Madrid' - 'Europe/Malta' - 'Europe/Monaco' - 'Europe/Oslo' - 'Europe/Paris' - 'Europe/Prague' - 'Europe/Rome' - 'Europe/Stockholm' - 'Europe/Tirane' - 'Europe/Vienna' - 'Europe/Warsaw' - 'Europe/Zurich' - 'Africa/Cairo' - 'Africa/Johannesburg' - 'Africa/Maputo' - 'Africa/Tripoli' - 'Asia/Amman' - 'Asia/Beirut' - 'Asia/Damascus' - 'Asia/Gaza' - 'Asia/Jerusalem' - 'Asia/Nicosia' - 'Europe/Athens' - 'Europe/Bucharest' - 'Europe/Chisinau' - 'Europe/Helsinki' - 'Europe/Istanbul' - 'Europe/Kaliningrad' - 'Europe/Kiev' - 'Europe/Riga' - 'Europe/Sofia' - 'Europe/Tallinn' - 'Europe/Vilnius' - 'Africa/Khartoum' - 'Africa/Nairobi' - 'Antarctica/Syowa' - 'Asia/Baghdad' - 'Asia/Qatar' - 'Asia/Riyadh' - 'Europe/Minsk' - 'Europe/Moscow' - 'Asia/Tehran' - 'Asia/Baku' - 'Asia/Dubai' - 'Asia/Tbilisi' - 'Asia/Yerevan' - 'Europe/Samara' - 'Indian/Mahe' - 'Indian/Mauritius' - 'Indian/Reunion' - 'Asia/Kabul' - 'Antarctica/Mawson' - 'Asia/Aqtau' - 'Asia/Aqtobe' - 'Asia/Ashgabat' - 'Asia/Dushanbe' - 'Asia/Karachi' - 'Asia/Tashkent' - 'Asia/Yekaterinburg' - 'Indian/Kerguelen' - 'Indian/Maldives' - 'Asia/Calcutta' - 'Asia/Kolkata' - 'Asia/Colombo' - 'Asia/Katmandu' - 'Antarctica/Vostok' - 'Asia/Almaty' - 'Asia/Bishkek' - 'Asia/Dhaka' - 'Asia/Omsk' - 'Asia/Thimphu' - 'Indian/Chagos' - 'Asia/Rangoon' - 'Indian/Cocos' - 'Antarctica/Davis' - 'Asia/Bangkok' - 'Asia/Hovd' - 'Asia/Jakarta' - 'Asia/Krasnoyarsk' - 'Asia/Saigon' - 'Indian/Christmas' - 'Antarctica/Casey' - 'Asia/Brunei' - 'Asia/Choibalsan' - 'Asia/Hong_Kong' - 'Asia/Irkutsk' - 'Asia/Kuala_Lumpur' - 'Asia/Macau' - 'Asia/Makassar' - 'Asia/Manila' - 'Asia/Shanghai' - 'Asia/Singapore' - 'Asia/Taipei' - 'Asia/Ulaanbaatar' - 'Australia/Perth' - 'Asia/Pyongyang' - 'Asia/Dili' - 'Asia/Jayapura' - 'Asia/Seoul' - 'Asia/Tokyo' - 'Asia/Yakutsk' - 'Pacific/Palau' - 'Australia/Adelaide' - 'Australia/Darwin' - 'Antarctica/DumontDUrville' - 'Asia/Magadan' - 'Asia/Vladivostok' - 'Australia/Brisbane' - 'Australia/Hobart' - 'Australia/Sydney' - 'Pacific/Chuuk' - 'Pacific/Guam' - 'Pacific/Port_Moresby' - 'Pacific/Efate' - 'Pacific/Guadalcanal' - 'Pacific/Kosrae' - 'Pacific/Norfolk' - 'Pacific/Noumea' - 'Pacific/Pohnpei' - 'Asia/Kamchatka' - 'Pacific/Auckland' - 'Pacific/Fiji' - 'Pacific/Funafuti' - 'Pacific/Kwajalein' - 'Pacific/Majuro' - 'Pacific/Nauru' - 'Pacific/Tarawa' - 'Pacific/Wake' - 'Pacific/Wallis' - 'Pacific/Apia' - 'Pacific/Enderbury' - 'Pacific/Fakaofo' - 'Pacific/Tongatapu' - 'Pacific/Kiritimati' default: Pacific/Niue x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.SysConfigPolicy.List: title: List of 'hyperflex.SysConfigPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.SysConfigPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.SysConfigPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.SysConfigPolicy' nullable: true hyperflex.UcsmConfigPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.UcsmConfigPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.UcsmConfigPolicy' resources. x-one-of-name: hyperflex.UcsmConfigPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.UcsmConfigPolicy.Relationship: description: A relationship to the 'hyperflex.UcsmConfigPolicy' resource, or the expanded 'hyperflex.UcsmConfigPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.UcsmConfigPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' hyperflex.UcsmConfigPolicy: title: UCSM Configuration description: |- A policy specifying UCS Manager settings such as service profile org, KVM IP addresses, and MAC prefix for server configuration in Fabric Interconnect environment. x-allOf-name: hyperflex.UcsmConfigPolicy allOf: - # This 'hyperflex.UcsmConfigPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.UcsmConfigPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.UcsmConfigPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.UcsmConfigPolicy' ObjectType: enum: - 'hyperflex.UcsmConfigPolicy' KvmIpRange: description: |- The Out-of-band KVM IP range. Configures the service profiles to use IP addresses within this range for setting the KVM IP of a server. $ref: '#/components/schemas/hyperflex.IpAddrRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MacPrefixRange: description: |- The MAC address prefix range for configuring vNICs. Configures the service profiles to use MAC address prefixes within this range for setting the MAC address of server vNICs. $ref: '#/components/schemas/hyperflex.MacAddrPrefixRange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ServerFirmwareVersion: description: |- The server firmware bundle version used for server components such as CIMC, adapters, BIOS, etc. type: string pattern: "(^3\\.[1-9]\\([1-9][a-z]\\)$|^[4-9]\\.[0-9]\\([1-9][a-z]\\)$)" x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.UcsmConfigPolicy.List: title: List of 'hyperflex.UcsmConfigPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.UcsmConfigPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.UcsmConfigPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.UcsmConfigPolicy' nullable: true hyperflex.VcenterConfigPolicy.Response: description: |- The response body of a HTTP GET request for the 'hyperflex.VcenterConfigPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'hyperflex.VcenterConfigPolicy' resources. x-one-of-name: hyperflex.VcenterConfigPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType hyperflex.VcenterConfigPolicy.Relationship: description: A relationship to the 'hyperflex.VcenterConfigPolicy' resource, or the expanded 'hyperflex.VcenterConfigPolicy' resource, or the 'null' value. x-one-of-name: hyperflex.VcenterConfigPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' hyperflex.VcenterConfigPolicy: title: vCenter description: |- A policy specifying vCenter configuration. x-allOf-name: hyperflex.VcenterConfigPolicy allOf: - # This 'hyperflex.VcenterConfigPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'hyperflex.VcenterConfigPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.VcenterConfigPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.VcenterConfigPolicy' ObjectType: enum: - 'hyperflex.VcenterConfigPolicy' DataCenter: description: |- The vCenter datacenter name. type: string pattern: "^[a-zA-Z0-9~!@#$%&*()-_][a-zA-Z0-9~!@#$%&* ()-_]{0,79}$" x-omitempty: true Hostname: description: |- The vCenter server FQDN or IP. type: string pattern: "^[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?$|^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)*(\\.[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$|^([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])\\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Password: description: |- The password for authenticating with vCenter. Follow the corresponding password policy governed by vCenter. type: string writeOnly: true x-omitempty: true SsoUrl: description: |- Overrides the default vCenter Single Sign-On URL. Do not specify unless instructed by Cisco TAC. type: string x-omitempty: true Username: description: |- The vCenter username (e.g. administrator@vsphere.local). type: string pattern: "^([a-zA-Z0-9._-]+)@([a-zA-Z0-9._-]+)$" x-omitempty: true ClusterProfiles: # A Relationship to MO hyperflex.ClusterProfile description: An array of relationships to hyperflexClusterProfile resources. type: array items: $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true hyperflex.VcenterConfigPolicy.List: title: List of 'hyperflex.VcenterConfigPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'hyperflex.VcenterConfigPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'hyperflex.VcenterConfigPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/hyperflex.VcenterConfigPolicy' nullable: true hyperflex.WwxnPrefixRange: title: Hyperflex:Wwxn Prefix Range description: |- A range of WWxN prefixes. The range is inclusive and comprised of a start and end WWxN addresses. A single address can be specified by setting it as the start and end of the range. x-allOf-name: hyperflex.WwxnPrefixRange allOf: - # This 'hyperflex.WwxnPrefixRange' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'hyperflex.WwxnPrefixRange' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'hyperflex.WwxnPrefixRange', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'hyperflex.WwxnPrefixRange' ObjectType: enum: - 'hyperflex.WwxnPrefixRange' EndAddr: description: |- The end WWxN prefix of a WWPN/WWNN range in the form of 20:00:00:25:B5:XX. type: string pattern: "^$|^20:00:00:25:B5:[0-9a-fA-F]{2}$" x-omitempty: true StartAddr: description: |- The start WWxN prefix of a WWPN/WWNN range in the form of 20:00:00:25:B5:XX. type: string pattern: "^$|^20:00:00:25:B5:[0-9a-fA-F]{2}$" x-omitempty: 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 allOf: - # This 'i18n.Message' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'i18n.Message' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'i18n.Message', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'i18n.Message' ObjectType: enum: - 'i18n.Message' Message: description: |- The default (en-US) localized message. Default localized message will be stored and directly retrieved when the 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true i18n.MessageParam: title: I18n:Message Param description: |- A key, value pair used to substitue variables when translating a message in a particular locale for internationalization purpose. x-allOf-name: i18n.MessageParam allOf: - # This 'i18n.MessageParam' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'i18n.MessageParam' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'i18n.MessageParam', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'i18n.MessageParam' ObjectType: enum: - 'i18n.MessageParam' 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 iaas.ConnectorPack.Response: description: |- The response body of a HTTP GET request for the 'iaas.ConnectorPack' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.ConnectorPack' resources. x-one-of-name: iaas.ConnectorPack.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.ConnectorPack.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.ConnectorPack.Relationship: description: A relationship to the 'iaas.ConnectorPack' resource, or the expanded 'iaas.ConnectorPack' resource, or the 'null' value. x-one-of-name: iaas.ConnectorPack.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/iaas.ConnectorPack' iaas.ConnectorPack: title: Iaas:Connector Pack description: |- Describes about all the connector pack versions running currently in UCSD. x-allOf-name: iaas.ConnectorPack allOf: - # This 'iaas.ConnectorPack' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.ConnectorPack' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.ConnectorPack', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.ConnectorPack' ObjectType: enum: - 'iaas.ConnectorPack' CompleteVersion: description: |- Complete version of the connector pack including build number. type: string readOnly: true x-omitempty: true DependencyNames: type: array items: description: |- List of dependent connectors on the UCSD for this connector. For example BigData depends on UCS Connector. type: string readOnly: true x-omitempty: true DownloadedVersion: description: |- Version of the connector pack that is last downloaded successfully to UCSD. type: string readOnly: true x-omitempty: true Name: description: |- Name of the connector pack running on the UCSD. type: string readOnly: true x-omitempty: true State: description: |- State of the connector pack whether it is enabled or disabled. type: string readOnly: true x-omitempty: true Version: description: |- Version of the connector pack. type: string readOnly: true x-omitempty: true Guid: # A Relationship to MO iaas.UcsdInfo $ref: '#/components/schemas/iaas.UcsdInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.ConnectorPack.List: title: List of 'iaas.ConnectorPack' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.ConnectorPack' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.ConnectorPack' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.ConnectorPack' nullable: true iaas.DeviceStatus.Response: description: |- The response body of a HTTP GET request for the 'iaas.DeviceStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.DeviceStatus' resources. x-one-of-name: iaas.DeviceStatus.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.DeviceStatus.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.DeviceStatus.Relationship: description: A relationship to the 'iaas.DeviceStatus' resource, or the expanded 'iaas.DeviceStatus' resource, or the 'null' value. x-one-of-name: iaas.DeviceStatus.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/iaas.DeviceStatus' iaas.DeviceStatus: title: Iaas:Device Status description: |- List of infra accounts managed by UCSD. x-allOf-name: iaas.DeviceStatus allOf: - # This 'iaas.DeviceStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.DeviceStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.DeviceStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.DeviceStatus' ObjectType: enum: - 'iaas.DeviceStatus' AccountName: description: |- The UCSD infra account name. Account Name is created when UCSD admin adds any new infra account (Physical/Virtual/Compute/Network) to be managed by UCSD. type: string readOnly: true x-omitempty: true AccountType: description: |- The UCSD Infra Account type. type: string readOnly: true x-omitempty: true Category: description: |- The UCSD Infra Account category. type: string readOnly: true x-omitempty: true ClaimStatus: description: |- Describes if the device is claimed in Intersight or not. * `Unknown` - If UCS Director managed account claim status information is unknown. * `Yes` - If UCS Director managed account is claimed in Intersight. * `No` - If UCS Director managed account is not claimed in Intersight. * `Not Applicable` - If UCS Director managed account is not capable of providing claim status information. type: string enum: - 'Unknown' - 'Yes' - 'No' - 'Not Applicable' default: Unknown readOnly: true x-omitempty: true ConnectionStatus: description: |- Describes about the connection status between the UCSD and the actual end device. type: string readOnly: true x-omitempty: true DeviceModel: description: |- Describes about the device model. type: string readOnly: true x-omitempty: true DeviceVendor: description: |- Describes about the device vendor/manufacturer of the device. type: string readOnly: true x-omitempty: true DeviceVersion: description: |- Describes about the current firmware version running on the device. type: string readOnly: true x-omitempty: true IpAddress: description: |- The IPAddress of the device. type: string readOnly: true x-omitempty: true Pod: description: |- Describes about the pod to which this device belongs to in UCSD. type: string readOnly: true x-omitempty: true PodType: description: |- Describes about the podType of Pod to which this device belongs to in UCSD. type: string readOnly: true x-omitempty: true Guid: # A Relationship to MO iaas.UcsdInfo $ref: '#/components/schemas/iaas.UcsdInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.DeviceStatus.List: title: List of 'iaas.DeviceStatus' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.DeviceStatus' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.DeviceStatus' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.DeviceStatus' nullable: true iaas.DiagnosticMessages.Response: description: |- The response body of a HTTP GET request for the 'iaas.DiagnosticMessages' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.DiagnosticMessages' resources. x-one-of-name: iaas.DiagnosticMessages.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.DiagnosticMessages.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.DiagnosticMessages: title: Iaas:Diagnostic Messages description: |- Gets diagnostics messages from UCSD. x-allOf-name: iaas.DiagnosticMessages allOf: - # This 'iaas.DiagnosticMessages' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.DiagnosticMessages' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.DiagnosticMessages', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.DiagnosticMessages' ObjectType: enum: - 'iaas.DiagnosticMessages' Category: description: |- Message category of the alerts. type: string readOnly: true x-omitempty: true Guid: description: |- Unique ID of UCS Director getting registerd with Intersight. type: string readOnly: true x-omitempty: true Item: description: |- Message target type of the alerts. type: string readOnly: true x-omitempty: true LastChecked: description: |- Last checked time of the alerts. type: string readOnly: true x-omitempty: true Message: description: |- Detailed info about the alert. type: string readOnly: true x-omitempty: true Recommendation: description: |- Recommended fix for the alert. type: string readOnly: true x-omitempty: true Status: description: |- Status of the given alert. type: string readOnly: true x-omitempty: true StatusId: description: |- Status Id of the given alert. type: string readOnly: true x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.DiagnosticMessages.List: title: List of 'iaas.DiagnosticMessages' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.DiagnosticMessages' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.DiagnosticMessages' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.DiagnosticMessages' nullable: true iaas.LicenseInfo.Response: description: |- The response body of a HTTP GET request for the 'iaas.LicenseInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.LicenseInfo' resources. x-one-of-name: iaas.LicenseInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.LicenseInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.LicenseInfo.Relationship: description: A relationship to the 'iaas.LicenseInfo' resource, or the expanded 'iaas.LicenseInfo' resource, or the 'null' value. x-one-of-name: iaas.LicenseInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/iaas.LicenseInfo' iaas.LicenseInfo: title: Iaas:License Info description: |- Describes about license info currently available in UCSD. x-allOf-name: iaas.LicenseInfo allOf: - # This 'iaas.LicenseInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.LicenseInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.LicenseInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.LicenseInfo' ObjectType: enum: - 'iaas.LicenseInfo' LicenseExpirationDate: description: |- UCS Director license expiration date. type: string readOnly: true x-omitempty: true LicenseKeysInfo: type: array items: description: |- License keys info for UCSD. $ref: '#/components/schemas/iaas.LicenseKeysInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true LicenseType: description: |- License type of UCSD whether it is EVAL/Permanent/Subscription.. type: string readOnly: true x-omitempty: true LicenseUtilizationInfo: type: array items: description: |- List of license utilization info for UCSD. $ref: '#/components/schemas/iaas.LicenseUtilizationInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Guid: # A Relationship to MO iaas.UcsdInfo $ref: '#/components/schemas/iaas.UcsdInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.LicenseInfo.List: title: List of 'iaas.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 'iaas.LicenseInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.LicenseInfo' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.LicenseInfo' nullable: true iaas.LicenseKeysInfo: title: Iaas:License Keys Info description: |- License list with the utilization info for UCSD. x-allOf-name: iaas.LicenseKeysInfo allOf: - # This 'iaas.LicenseKeysInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iaas.LicenseKeysInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.LicenseKeysInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.LicenseKeysInfo' ObjectType: enum: - 'iaas.LicenseKeysInfo' Count: description: |- Number of licenses available for the UCSD PID (Product ID). type: integer format: int64 readOnly: true x-omitempty: true ExpirationDate: description: |- Expiration date for the license. type: string readOnly: true x-omitempty: true LicenseId: description: |- UCS Director Unique license ID. type: string readOnly: true x-omitempty: true Pid: description: |- PID (Product ID) for UCSD License. type: string readOnly: true x-omitempty: true iaas.LicenseUtilizationInfo: title: Iaas:License Utilization Info description: |- License list with the Utilization info for UCSD. x-allOf-name: iaas.LicenseUtilizationInfo allOf: - # This 'iaas.LicenseUtilizationInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iaas.LicenseUtilizationInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.LicenseUtilizationInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.LicenseUtilizationInfo' ObjectType: enum: - 'iaas.LicenseUtilizationInfo' ActualUsed: description: |- Number of licenses actually used for this feature. type: integer format: int64 readOnly: true x-omitempty: true Label: description: |- License label of UCSD license. type: string readOnly: true x-omitempty: true LicensedLimit: description: |- License limit for this license feature. type: string readOnly: true x-omitempty: true Sku: description: |- SKU for the UCSD license. type: string readOnly: true x-omitempty: true iaas.MostRunTasks.Response: description: |- The response body of a HTTP GET request for the 'iaas.MostRunTasks' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.MostRunTasks' resources. x-one-of-name: iaas.MostRunTasks.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.MostRunTasks.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.MostRunTasks.Relationship: description: A relationship to the 'iaas.MostRunTasks' resource, or the expanded 'iaas.MostRunTasks' resource, or the 'null' value. x-one-of-name: iaas.MostRunTasks.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/iaas.MostRunTasks' iaas.MostRunTasks: title: Iaas:Most Run Tasks description: |- Describes most run workflow tasks within UCSD. x-allOf-name: iaas.MostRunTasks allOf: - # This 'iaas.MostRunTasks' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.MostRunTasks' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.MostRunTasks', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.MostRunTasks' ObjectType: enum: - 'iaas.MostRunTasks' TaskCategory: description: |- A functional area to which a task belongs to. type: string readOnly: true x-omitempty: true TaskExecutionCount: description: |- Number of times this task has executed. type: integer format: int64 readOnly: true x-omitempty: true TaskName: description: |- Name of the task executed in UCSD. type: string readOnly: true x-omitempty: true TaskType: description: |- Type of the task whether it is system task or custom task. type: string readOnly: true x-omitempty: true Guid: # A Relationship to MO iaas.UcsdInfo $ref: '#/components/schemas/iaas.UcsdInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.MostRunTasks.List: title: List of 'iaas.MostRunTasks' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.MostRunTasks' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.MostRunTasks' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.MostRunTasks' nullable: true iaas.ServiceRequest.Response: description: |- The response body of a HTTP GET request for the 'iaas.ServiceRequest' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.ServiceRequest' resources. x-one-of-name: iaas.ServiceRequest.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.ServiceRequest.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.ServiceRequest: title: Iaas:Service Request description: |- Gets last six months Service Requests from UCSD. x-allOf-name: iaas.ServiceRequest allOf: - # This 'iaas.ServiceRequest' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.ServiceRequest' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.ServiceRequest', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.ServiceRequest' ObjectType: enum: - 'iaas.ServiceRequest' Duration: description: |- Service request duration. type: string readOnly: true x-omitempty: true InitiatingUser: description: |- Service Request initiating user. type: string readOnly: true x-omitempty: true RequestEndTime: description: |- Service request end time. type: string readOnly: true x-omitempty: true RequestId: description: |- Service request id of an SR. type: string readOnly: true x-omitempty: true RequestStartTime: description: |- Service request start time. type: string readOnly: true x-omitempty: true RequestType: description: |- Service request type of an SR. type: string readOnly: true x-omitempty: true Status: description: |- UCSD service request status. type: string readOnly: true x-omitempty: true WorkflowName: description: |- Executed workflow name for an SR. type: string readOnly: true x-omitempty: true WorkflowSteps: type: array items: description: |- Step details of Service Request. $ref: '#/components/schemas/iaas.WorkflowSteps' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.ServiceRequest.List: title: List of 'iaas.ServiceRequest' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.ServiceRequest' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.ServiceRequest' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.ServiceRequest' nullable: true iaas.UcsdInfo.Response: description: |- The response body of a HTTP GET request for the 'iaas.UcsdInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.UcsdInfo' resources. x-one-of-name: iaas.UcsdInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.UcsdInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.UcsdInfo.Relationship: description: A relationship to the 'iaas.UcsdInfo' resource, or the expanded 'iaas.UcsdInfo' resource, or the 'null' value. x-one-of-name: iaas.UcsdInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/iaas.UcsdInfo' iaas.UcsdInfo: title: Iaas:Ucsd Info description: |- UCS Director accounts managed by Intersight. x-allOf-name: iaas.UcsdInfo allOf: - # This 'iaas.UcsdInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.UcsdInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.UcsdInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.UcsdInfo' ObjectType: enum: - 'iaas.UcsdInfo' DeviceId: description: |- Moid of the UCS Director device connector's asset.DeviceRegistration. type: string readOnly: true x-omitempty: true Guid: description: |- Unique ID of UCS Director getting registerd with Intersight. type: string readOnly: true x-omitempty: true HostName: description: |- The UCS Director hostname for management. type: string readOnly: true x-omitempty: true Ip: description: |- The UCS Director IP address for management. type: string readOnly: true x-omitempty: true LastBackup: description: |- Last successful backup created for this UCS Director appliance if backup is configured. type: string format: date-time readOnly: true x-omitempty: true NodeType: description: |- NodeType specifies if UCS Director is deployed in Stand-alone or Multi Node. type: string readOnly: true x-omitempty: true ProductName: description: |- The UCS Director product name. type: string readOnly: true x-omitempty: true ProductVendor: description: |- The UCS Director product vendor. type: string readOnly: true x-omitempty: true ProductVersion: description: |- The UCS Director product/platform version. type: string readOnly: true x-omitempty: true Status: description: |- The UCS Director status. Possible values are Active, Inactive, Unknown. type: string readOnly: true x-omitempty: true ConnectorPack: # A Relationship to MO iaas.ConnectorPack description: An array of relationships to iaasConnectorPack resources. type: array items: $ref: '#/components/schemas/iaas.ConnectorPack.Relationship' nullable: true readOnly: true DeviceStatus: # A Relationship to MO iaas.DeviceStatus description: An array of relationships to iaasDeviceStatus resources. type: array items: $ref: '#/components/schemas/iaas.DeviceStatus.Relationship' nullable: true readOnly: true LicenseInfo: # A Relationship to MO iaas.LicenseInfo $ref: '#/components/schemas/iaas.LicenseInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasLicenseInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MostRunTasks: # A Relationship to MO iaas.MostRunTasks description: An array of relationships to iaasMostRunTasks resources. type: array items: $ref: '#/components/schemas/iaas.MostRunTasks.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true UcsdManagedInfra: # A Relationship to MO iaas.UcsdManagedInfra $ref: '#/components/schemas/iaas.UcsdManagedInfra.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdManagedInfra resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.UcsdInfo.List: title: List of 'iaas.UcsdInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.UcsdInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.UcsdInfo' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.UcsdInfo' nullable: true iaas.UcsdManagedInfra.Response: description: |- The response body of a HTTP GET request for the 'iaas.UcsdManagedInfra' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.UcsdManagedInfra' resources. x-one-of-name: iaas.UcsdManagedInfra.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.UcsdManagedInfra.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.UcsdManagedInfra.Relationship: description: A relationship to the 'iaas.UcsdManagedInfra' resource, or the expanded 'iaas.UcsdManagedInfra' resource, or the 'null' value. x-one-of-name: iaas.UcsdManagedInfra.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/iaas.UcsdManagedInfra' iaas.UcsdManagedInfra: title: Iaas:Ucsd Managed Infra description: |- Describes about UCSD Managed infrastructure statistics. x-allOf-name: iaas.UcsdManagedInfra allOf: - # This 'iaas.UcsdManagedInfra' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.UcsdManagedInfra' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.UcsdManagedInfra', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.UcsdManagedInfra' ObjectType: enum: - 'iaas.UcsdManagedInfra' AdvancedCatalogCount: description: |- Total advanced catalogs in UCSD. type: integer format: int64 readOnly: true x-omitempty: true BmCatalogCount: description: |- Total bare metal catalogs in UCSD. type: integer format: int64 readOnly: true x-omitempty: true ContainerCatalogCount: description: |- Total service container catalogs in UCSD. type: integer format: int64 readOnly: true x-omitempty: true EsxiHostCount: description: |- Total ESXi hosts in UCSD. type: integer format: int64 readOnly: true x-omitempty: true ExternalGroupCount: description: |- Total external (Ldap) groups in UCSD. type: integer format: int64 readOnly: true x-omitempty: true HypervHostCount: description: |- Total HyperV hosts in UCSD. type: integer format: int64 readOnly: true x-omitempty: true LocalGroupCount: description: |- Total local groups in UCSD. type: integer format: int64 readOnly: true x-omitempty: true StandardCatalogCount: description: |- Total standard catalogs in UCSD. type: integer format: int64 readOnly: true x-omitempty: true UserCount: description: |- Total user accounts in UCSD. type: integer format: int64 readOnly: true x-omitempty: true VdcCount: description: |- Total virtual datacenters in UCSD. type: integer format: int64 readOnly: true x-omitempty: true VmCount: description: |- Total Virtual machines in UCSD. type: integer format: int64 readOnly: true x-omitempty: true Guid: # A Relationship to MO iaas.UcsdInfo $ref: '#/components/schemas/iaas.UcsdInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iaasUcsdInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.UcsdManagedInfra.List: title: List of 'iaas.UcsdManagedInfra' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.UcsdManagedInfra' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.UcsdManagedInfra' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.UcsdManagedInfra' nullable: true iaas.UcsdMessages.Response: description: |- The response body of a HTTP GET request for the 'iaas.UcsdMessages' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'iaas.UcsdMessages' resources. x-one-of-name: iaas.UcsdMessages.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/iaas.UcsdMessages.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType iaas.UcsdMessages: title: Iaas:Ucsd Messages description: |- Gets ucsd messages from UCSD. x-allOf-name: iaas.UcsdMessages allOf: - # This 'iaas.UcsdMessages' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iaas.UcsdMessages' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.UcsdMessages', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.UcsdMessages' ObjectType: enum: - 'iaas.UcsdMessages' StatusId: description: |- Last checked time of the alerts. type: string readOnly: true x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iaas.UcsdMessages.List: title: List of 'iaas.UcsdMessages' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'iaas.UcsdMessages' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'iaas.UcsdMessages' resources matching the request. type: array items: $ref: '#/components/schemas/iaas.UcsdMessages' nullable: true iaas.WorkflowSteps: title: Iaas:Workflow Steps description: |- Workflow steps info for UCSD SR. x-allOf-name: iaas.WorkflowSteps allOf: - # This 'iaas.WorkflowSteps' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iaas.WorkflowSteps' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iaas.WorkflowSteps', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iaas.WorkflowSteps' ObjectType: enum: - 'iaas.WorkflowSteps' CompletedTime: description: |- Completed time of the workflow step. type: string readOnly: true x-omitempty: true Name: description: |- Name of the workflow step. type: string readOnly: true x-omitempty: true Status: description: |- Status of the workflow step. type: string readOnly: true x-omitempty: true StatusMessage: description: |- Status message of the workflow step. type: string readOnly: true x-omitempty: true iam.Account.Response: description: |- The response body of a HTTP GET request for the 'iam.Account' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.Account: title: Iam:Account description: |- The Intersight Account used to access Intersight. x-allOf-name: iam.Account allOf: - # This 'iam.Account' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Account' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Account', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Account' ObjectType: enum: - 'iam.Account' 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 Status: description: |- Status of the account. To activate the Intersight account, claim a device to the account. type: string readOnly: true x-omitempty: true _0_LicenseReservationOp: # A Relationship to MO license.LicenseReservationOp $ref: '#/components/schemas/license.LicenseReservationOp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a licenseLicenseReservationOp resource. When the $expand query parameter is specified, the referenced resource is returned inline. AppRegistrations: # A Relationship to MO iam.AppRegistration description: An array of relationships to iamAppRegistration resources. type: array items: $ref: '#/components/schemas/iam.AppRegistration.Relationship' nullable: true readOnly: true DomainGroups: # A Relationship to MO iam.DomainGroup description: An array of relationships to iamDomainGroup resources. type: array items: $ref: '#/components/schemas/iam.DomainGroup.Relationship' nullable: true readOnly: true EndPointRoles: # A Relationship to MO iam.EndPointRole description: An array of relationships to iamEndPointRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointRole.Relationship' nullable: true readOnly: true Idpreferences: # A Relationship to MO iam.IdpReference description: An array of relationships to iamIdpReference resources. type: array items: $ref: '#/components/schemas/iam.IdpReference.Relationship' nullable: true readOnly: true Idps: # A Relationship to MO iam.Idp description: An array of relationships to iamIdp resources. type: array items: $ref: '#/components/schemas/iam.Idp.Relationship' nullable: true readOnly: true Permissions: # A Relationship to MO iam.Permission description: An array of relationships to iamPermission resources. type: array items: $ref: '#/components/schemas/iam.Permission.Relationship' nullable: true readOnly: true PrivilegeSets: # A Relationship to MO iam.PrivilegeSet description: An array of relationships to iamPrivilegeSet resources. type: array items: $ref: '#/components/schemas/iam.PrivilegeSet.Relationship' nullable: true readOnly: true Privileges: # A Relationship to MO iam.Privilege description: An array of relationships to iamPrivilege resources. type: array items: $ref: '#/components/schemas/iam.Privilege.Relationship' nullable: true readOnly: true ResourceLimits: # A Relationship to MO iam.ResourceLimits $ref: '#/components/schemas/iam.ResourceLimits.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamResourceLimits resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Roles: # A Relationship to MO iam.Role description: An array of relationships to iamRole resources. type: array items: $ref: '#/components/schemas/iam.Role.Relationship' nullable: true readOnly: true SecurityHolder: # A Relationship to MO iam.SecurityHolder $ref: '#/components/schemas/iam.SecurityHolder.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSecurityHolder resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true SessionLimits: # A Relationship to MO iam.SessionLimits $ref: '#/components/schemas/iam.SessionLimits.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSessionLimits resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- The beta features enabled for the specified account. x-allOf-name: iam.AccountExperience allOf: - # This 'iam.AccountExperience' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.AccountExperience' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.AccountExperience', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.AccountExperience' ObjectType: enum: - 'iam.AccountExperience' Features: type: array items: description: |- The list of enabled beta features for the account. $ref: '#/components/schemas/iam.FeatureDefinition' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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 allOf: - # This 'iam.AccountPermissions' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.AccountPermissions' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.AccountPermissions', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.AccountPermissions' ObjectType: enum: - 'iam.AccountPermissions' 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 AccountStatus: description: |- Status of the account. Account remains inactive until a device is claimed to the account. 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true iam.ApiKey.Response: description: |- The response body of a HTTP GET request for the 'iam.ApiKey' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.ApiKey: title: Iam:Api Key description: |- API keys are used to programatically perform API calls. API keys can be created by passing purpose field, which is a description for the application using API keys. Maximum of 3 API keys per user is allowed. API key will have RSA key pair generated and as part of create request key MOID, private and public key in PEM format are returned. In Intersight only the public key is stored. Client side private key is stored and is used for signature calculation. API key requests are authenticated using RSA SHA 256 signature validations. If the incoming request for authorization has X-Starship-Token, then session based authorization is done, else API key based authorization is performed. Once User, API key and Account are found and signature verification succeeds, then the privilege validations are performed. x-allOf-name: iam.ApiKey allOf: - # This 'iam.ApiKey' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.ApiKey' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.ApiKey', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.ApiKey' ObjectType: enum: - 'iam.ApiKey' HashAlgorithm: description: |- The cryptographic hash algorithm to calculate the message digest. * `SHA256` - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4. * `SHA384` - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4. * `SHA512` - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4. * `SHA512_224` - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4. * `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 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-createOnly: 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 x-omitempty: true SigningAlgorithm: description: |- The signing algorithm used by the client to authenticate API requests to Intersight. The signing algorithm must be compatible with the key generation specification. * `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. * `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. * `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. * `Ecdsa` - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANS X9.62. type: string enum: - 'RSASSA-PKCS1-v1_5' - 'RSASSA-PSS' - 'Ed25519' - 'Ecdsa' default: RSASSA-PKCS1-v1_5 x-createOnly: true x-omitempty: true Permission: # A Relationship to MO iam.Permission $ref: '#/components/schemas/iam.Permission.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPermission resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true User: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When 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. The '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.AppRegistration.Response: description: |- The response body of a HTTP GET request for the 'iam.AppRegistration' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.AppRegistration: title: App Registration description: |- AppRegistration encapsulates the meta-data values of a registered OAuth2 client application, as described in https://tools.ietf.org/html/rfc7591#section-2. Registered client applications have a set of metadata values associated with their client identifier at the Intersight authorization server, including the list of valid redirection URIs or a display name. The meta-data is used to specify how a client application can retrieve a OAuth2 Access Token and subsequently invoke Intersight API on behalf of this AppRegistration. To register an OAuth2 application, the following information must be provided. 1) Application name 2) An icon for the application 3) URL to the application's home page 4) A short description of the application 5) A list of redirect URLs When an AppRegistration is created, a unique OAuth2 clientId is generated and returned in the HTTP response. x-allOf-name: iam.AppRegistration allOf: - # This 'iam.AppRegistration' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.AppRegistration' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.AppRegistration', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.AppRegistration' ObjectType: enum: - 'iam.AppRegistration' ClientId: description: |- A unique identifier for the OAuth2 client application. The 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. The value of this property is generated when grantType includes 'client-credentials'. Otherwise, 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. * `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. * `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 GrantTypes: type: array items: description: |- The set of grant types that OAuth2 clients can use for this application. The grant type is used in the OAuth2 login flow to validate the grant type that has been requested by the client. See https://tools.ietf.org/html/rfc7591#page-9 for more details. # It is set automatically when AppRegistration is created since currently we do not provide option for the user. * `authorization_code` - The 'authorization code' grant type as defined in the OAuth2 specification.It implies a "response_types" value that includes "code". * `refresh_token` - The 'refresh token' grant type defined in the OAuth2 specification.https://tools.ietf.org/html/rfc7591#section-6. * `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. * `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. * `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). * `urn:ietf:params:oauth:grant-type:jwt-bearer` - The JWT Bearer Token Grant Type defined in OAuth JWT Bearer Token Profiles [RFC7523]. * `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 RedirectUris: type: array items: description: |- After a user successfully authorizes an application, the OAuth2 authorization server will redirect the user back to the application with either an authorization code or access token in the URL. Registered redirect URLs may contain query string parameters, but must not contain anything in the fragment. The registration server rejects the request if a user tries to register a redirect URL that contains a fragment. For native and mobile apps, Intersight allows a user to register a URL scheme such as myapp:// which can then be used in the redirect URL. The authorization server allows arbitrary URL schemes to be registered in order to support registering redirect URLs for native apps. Redirect URLs are a critical part of the OAuth flow. After a user successfully authorizes an application, the authorization server will redirect the user back to the application with either an authorization code or access token in the URL. Because the redirect URL will contain sensitive information, it is critical that the service doesn’t redirect the user to arbitrary locations. The best way to ensure the user will only be directed to appropriate locations is to require the developer to register one or more redirect URLs when they create the application. The redirection endpoint URI MUST be an absolute URI. type: string pattern: "^$|^(?:[\\w.-]+?:\\/\\/)[\\w.-]+$" x-omitempty: true RenewClientSecret: description: |- Set value to true to renew the client-secret. Applicable to client_credentials grant type. type: boolean x-omitempty: true ResponseTypes: type: array items: description: |- The set of response types that a OAuth2 client can use. This is static list and it is set automatically when AppRegistration is created. According to RFC, it is used in OAuth2 login flow to check that this AppRegistration supports response type from the request. See https://tools.ietf.org/html/rfc7591#page-9 for more details. * `code` - The authorization code response type defined in OAuth2, section 4.1. * `token` - The token response type defined in OAuth2, section 4.2. type: string enum: - 'code' - 'token' default: code readOnly: true x-omitempty: true RevocationTimestamp: description: |- Used to perform revocation for tokens of AppRegistration. Updated only internally is case Revoke property come from UI with value true. On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of the corresponding App Registration. type: string format: date-time readOnly: true x-omitempty: true Revoke: description: |- Used to trigger update the revocationTimestamp value. If UI sent updating request with the Revoke value is true, then update RevocationTimestamp. type: boolean x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true OauthTokens: # A Relationship to MO iam.OAuthToken description: An array of relationships to iamOAuthToken resources. type: array items: $ref: '#/components/schemas/iam.OAuthToken.Relationship' nullable: true readOnly: true Permission: # A Relationship to MO iam.Permission $ref: '#/components/schemas/iam.Permission.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPermission resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Roles: # A Relationship to MO iam.Role deprecated: true description: An array of relationships to iamRole resources. type: array items: $ref: '#/components/schemas/iam.Role.Relationship' nullable: true User: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When 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. The '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.Certificate.Response: description: |- The response body of a HTTP GET request for the 'iam.Certificate' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.Certificate: title: Iam:Certificate description: |- Holds a certificate, signed by a CAcert. x-allOf-name: iam.Certificate allOf: - # This 'iam.Certificate' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Certificate' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Certificate', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Certificate' ObjectType: enum: - 'iam.Certificate' Certificate: description: |- User-input pem-encoded certificate, signed by a CAcert. $ref: '#/components/schemas/x509.Certificate' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Status: description: |- Status of the certificate. * `PendingValidation` - The certificate has not been validated. * `Valid` - The certificate is valid. * `Invalid` - Ther certificate is invalid. type: string enum: - 'PendingValidation' - 'Valid' - 'Invalid' default: PendingValidation readOnly: true x-omitempty: true CertificateRequest: # A Relationship to MO iam.CertificateRequest $ref: '#/components/schemas/iam.CertificateRequest.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamCertificateRequest resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.CertificateRequest: title: Iam:Certificate Request description: |- The information required to generate a certificate signing request (CSR), which 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: - # This 'iam.CertificateRequest' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.CertificateRequest' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.CertificateRequest', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.CertificateRequest' ObjectType: enum: - 'iam.CertificateRequest' 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 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SubjectAlternateName: description: |- The x.509 subject alternate name values of the certificate request. $ref: '#/components/schemas/pkix.SubjectAlternateName' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Certificate: # A Relationship to MO iam.Certificate $ref: '#/components/schemas/iam.Certificate.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamCertificate resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true PrivateKeySpec: # A Relationship to MO iam.PrivateKeySpec $ref: '#/components/schemas/iam.PrivateKeySpec.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPrivateKeySpec resource. When 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. The '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 allOf: - # This 'iam.ClientMeta' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.ClientMeta' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.ClientMeta', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.ClientMeta' ObjectType: enum: - 'iam.ClientMeta' 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. Example - 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 It is set when User successfully passed OAuth login flow and receives Access Token. type: string x-omitempty: true iam.DomainGroup.Response: description: |- The response body of a HTTP GET request for the 'iam.DomainGroup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.DomainGroup: title: Iam:Domain Group description: |- Intersight services are mapped to three different categories of services for scaling purpose. Three categories are defined: Partition1/Partition2/Partition3. Topics for each category are created with a specific number of partitions. For each cloud environment these numbers will be different. x-allOf-name: iam.DomainGroup allOf: - # This 'iam.DomainGroup' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.DomainGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.DomainGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.DomainGroup' ObjectType: enum: - 'iam.DomainGroup' 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 parition 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. Device 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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.EndPointPasswordProperties: title: Iam:End Point Password Properties description: |- Password properties for endpoint users. x-allOf-name: iam.EndPointPasswordProperties allOf: - # This 'iam.EndPointPasswordProperties' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.EndPointPasswordProperties' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.EndPointPasswordProperties', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.EndPointPasswordProperties' ObjectType: enum: - 'iam.EndPointPasswordProperties' EnablePasswordExpiry: description: |- Enables password expiry on the endpoint. type: boolean 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 20 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 x-omitempty: true ForceSendPassword: description: |- User password will always be sent to endpoint device. If the option is not selected, then users password will be sent to endpoint device if password is changed for existing users and for new users. type: boolean x-omitempty: true GracePeriod: description: |- Time period until when you can use the existing password, after it expires. type: integer format: int64 minimum: 0 maximum: 5 x-omitempty: true NotificationPeriod: description: |- The duration after which the password will expire. type: integer format: int64 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 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 minimum: 0 maximum: 5 x-omitempty: true iam.EndPointPrivilege.Response: description: |- The response body of a HTTP GET request for the 'iam.EndPointPrivilege' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.EndPointPrivilege: title: Iam:End Point Privilege description: |- The privilege defined at the end point which can be assigned to a user. x-allOf-name: iam.EndPointPrivilege allOf: - # This 'iam.EndPointPrivilege' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.EndPointPrivilege' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.EndPointPrivilege', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.EndPointPrivilege' ObjectType: enum: - 'iam.EndPointPrivilege' 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. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' default: "" readOnly: true x-omitempty: true System: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.EndPointRole: title: Iam:End Point Role description: |- The role defined in the end point which can be assigned to a user. x-allOf-name: iam.EndPointRole allOf: - # This 'iam.EndPointRole' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.EndPointRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.EndPointRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.EndPointRole' ObjectType: enum: - 'iam.EndPointRole' 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. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' default: "" readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EndPointPrivileges: # A Relationship to MO iam.EndPointPrivilege description: An array of relationships to iamEndPointPrivilege resources. type: array items: $ref: '#/components/schemas/iam.EndPointPrivilege.Relationship' nullable: true readOnly: true System: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.EndPointUser: title: User description: |- Endpoint User or Local User. x-allOf-name: iam.EndPointUser allOf: - # This 'iam.EndPointUser' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.EndPointUser' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.EndPointUser', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.EndPointUser' ObjectType: enum: - 'iam.EndPointUser' 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: # A Relationship to MO iam.EndPointUserRole description: An array of relationships to iamEndPointUserRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointUserRole.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When 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. The '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.EndPointUserPolicy.Response: description: |- The response body of a HTTP GET request for the 'iam.EndPointUserPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.EndPointUserPolicy: title: Local User description: |- Enables creation of local users on endpoints. x-allOf-name: iam.EndPointUserPolicy allOf: - # This 'iam.EndPointUserPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'iam.EndPointUserPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.EndPointUserPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.EndPointUserPolicy' ObjectType: enum: - 'iam.EndPointUserPolicy' PasswordProperties: description: |- Set password properties for endpoint users. $ref: '#/components/schemas/iam.EndPointPasswordProperties' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true EndPointUserRoles: # A Relationship to MO iam.EndPointUserRole description: An array of relationships to iamEndPointUserRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointUserRole.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile 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. The '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.EndPointUserRole.Response: description: |- The response body of a HTTP GET request for the 'iam.EndPointUserRole' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.EndPointUserRole: title: Iam:End Point User Role description: |- Mapping of endpoint user to endpoint roles. x-allOf-name: iam.EndPointUserRole allOf: - # This 'iam.EndPointUserRole' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.EndPointUserRole' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.EndPointUserRole', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.EndPointUserRole' ObjectType: enum: - 'iam.EndPointUserRole' 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 readOnly: true x-omitempty: true Password: description: |- Valid login password of the user. type: string pattern: "^[a-zA-Z0-9!@#$%^&\\*+-_=]+$" minLength: 8 maxLength: 127 writeOnly: true x-omitempty: true EndPointRole: # A Relationship to MO iam.EndPointRole description: An array of relationships to iamEndPointRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointRole.Relationship' nullable: true EndPointUser: # A Relationship to MO iam.EndPointUser $ref: '#/components/schemas/iam.EndPointUser.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamEndPointUser resource. When the $expand query parameter is specified, the referenced resource is returned inline. EndPointUserPolicy: # A Relationship to MO iam.EndPointUserPolicy $ref: '#/components/schemas/iam.EndPointUserPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamEndPointUserPolicy resource. When 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. The '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.FeatureDefinition: title: Iam:Feature Definition description: |- Feature parameters specified for the account. x-allOf-name: iam.FeatureDefinition allOf: - # This 'iam.FeatureDefinition' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.FeatureDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.FeatureDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.FeatureDefinition' ObjectType: enum: - 'iam.FeatureDefinition' Feature: description: |- The beta feature that will be enabled for specific account. * `IWO` - Intersight Workflow Optimizer. type: string enum: - 'IWO' 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 allOf: - # This 'iam.GroupPermissionToRoles' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.GroupPermissionToRoles' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.GroupPermissionToRoles', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.GroupPermissionToRoles' ObjectType: enum: - 'iam.GroupPermissionToRoles' Group: description: |- Moid of the resource group. $ref: '#/components/schemas/cmrf.CmRf' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Orgs: type: array items: description: |- Moids of the associated organizations. $ref: '#/components/schemas/cmrf.CmRf' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true iam.Idp.Response: description: |- The response body of a HTTP GET request for the 'iam.Idp' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'iam.Idp' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Idp' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Idp', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Idp' ObjectType: enum: - 'iam.Idp' 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. 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 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 Type: description: |- Authentication protocol used by the IdP. * `saml` - Use SAML as the authentication protocol for sign-on. * `oidc` - Open ID connect to be used as an authentication protocol for sign-on. * `local` - The local authentication method to be used for sign-on. Local type is set to default for the Intersight Appliance IdP. type: string enum: - 'saml' - 'oidc' - 'local' default: saml x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true LdapPolicy: # A Relationship to MO iam.LdapPolicy $ref: '#/components/schemas/iam.LdapPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamLdapPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true System: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true UserPreferences: # A Relationship to MO iam.UserPreference description: An array of relationships to iamUserPreference resources. type: array items: $ref: '#/components/schemas/iam.UserPreference.Relationship' nullable: true readOnly: true Usergroups: # A Relationship to MO iam.UserGroup description: An array of relationships to iamUserGroup resources. type: array items: $ref: '#/components/schemas/iam.UserGroup.Relationship' nullable: true Users: # A Relationship to MO iam.User 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.IdpReference: title: Iam:Idp Reference description: |- Default Cisco IdP for authentication. x-allOf-name: iam.IdpReference allOf: - # This 'iam.IdpReference' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.IdpReference' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.IdpReference', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.IdpReference' ObjectType: enum: - 'iam.IdpReference' DomainName: description: |- The email domain name for this IdP of the user. 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 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 x-omitempty: true Name: description: |- Cisco IdP reference in an account. type: string readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Idp: # A Relationship to MO iam.Idp $ref: '#/components/schemas/iam.Idp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdp resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true UserPreferences: # A Relationship to MO iam.UserPreference description: An array of relationships to iamUserPreference resources. type: array items: $ref: '#/components/schemas/iam.UserPreference.Relationship' nullable: true readOnly: true Usergroups: # A Relationship to MO iam.UserGroup description: An array of relationships to iamUserGroup resources. type: array items: $ref: '#/components/schemas/iam.UserGroup.Relationship' nullable: true Users: # A Relationship to MO iam.User 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.IpAccessManagement: title: IP Access Management description: |- The access management based on IP address. x-allOf-name: iam.IpAccessManagement allOf: - # This 'iam.IpAccessManagement' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.IpAccessManagement' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.IpAccessManagement', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.IpAccessManagement' ObjectType: enum: - 'iam.IpAccessManagement' 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: # A Relationship to MO iam.SecurityHolder $ref: '#/components/schemas/iam.SecurityHolder.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSecurityHolder resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true IpAddresses: # A Relationship to MO iam.IpAddress 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.IpAddress: title: IP Address description: |- Add an IP address to enable IP address based access management. x-allOf-name: iam.IpAddress allOf: - # This 'iam.IpAddress' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.IpAddress' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.IpAddress', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.IpAddress' ObjectType: enum: - 'iam.IpAddress' 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: # A Relationship to MO iam.IpAccessManagement $ref: '#/components/schemas/iam.IpAccessManagement.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIpAccessManagement resource. When 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. The '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 allOf: - # This 'iam.LdapBaseProperties' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.LdapBaseProperties' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.LdapBaseProperties', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.LdapBaseProperties' ObjectType: enum: - 'iam.LdapBaseProperties' 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). Starting point from where server will search for users and groups. type: string maxLength: 254 x-omitempty: true BindDn: description: |- Distinguished Name (DN) of the user, that is used to authenticate against LDAP servers. type: string minLength: 0 maxLength: 254 x-omitempty: true BindMethod: description: |- Authentication method to access LDAP servers. * `LoginCredentials` - Requires the user credentials. If the bind process fails, then user is denied access. * `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. * `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 it sends 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 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 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 minimum: 1 maximum: 128 x-omitempty: true Password: description: |- Password of the user, that is used to authenticate. type: string pattern: "^[\\S+]{0,254}$" writeOnly: true x-omitempty: true Timeout: description: |- LDAP authentication timeout duration, in seconds. type: integer format: int64 minimum: 0 maximum: 180 x-omitempty: true iam.LdapDnsParameters: title: Iam:Ldap Dns Parameters description: |- DNS settings used to access LDAP Providers. x-allOf-name: iam.LdapDnsParameters allOf: - # This 'iam.LdapDnsParameters' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.LdapDnsParameters' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.LdapDnsParameters', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.LdapDnsParameters' ObjectType: enum: - 'iam.LdapDnsParameters' 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. * `Extracted` - The domain name extracted-domain from the login ID. * `Configured` - The configured-search domain. * `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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.LdapGroup: title: Iam:Ldap Group description: |- Mapping of LDAP Group to EndPointRoles. x-allOf-name: iam.LdapGroup allOf: - # This 'iam.LdapGroup' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.LdapGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.LdapGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.LdapGroup' ObjectType: enum: - 'iam.LdapGroup' 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 Name: description: |- LDAP Group name in the LDAP server database. type: string pattern: "^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$" maxLength: 127 x-omitempty: true EndPointRole: # A Relationship to MO iam.EndPointRole description: An array of relationships to iamEndPointRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointRole.Relationship' nullable: true LdapPolicy: # A Relationship to MO iam.LdapPolicy $ref: '#/components/schemas/iam.LdapPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamLdapPolicy resource. When 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. The '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.LdapPolicy.Response: description: |- The response body of a HTTP GET request for the 'iam.LdapPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.LdapPolicy: title: LDAP description: |- LDAP Policy configurations. x-allOf-name: iam.LdapPolicy allOf: - # This 'iam.LdapPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'iam.LdapPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.LdapPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.LdapPolicy' ObjectType: enum: - 'iam.LdapPolicy' BaseProperties: description: |- Base settings of LDAP required while configuring LDAP policy. $ref: '#/components/schemas/iam.LdapBaseProperties' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true DnsParameters: description: |- Configuration settings to resolve LDAP servers, when DNS is enabled. $ref: '#/components/schemas/iam.LdapDnsParameters' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true EnableDns: description: |- Enables DNS to access LDAP servers. type: boolean x-omitempty: true Enabled: description: |- LDAP server performs authentication. type: boolean x-omitempty: true UserSearchPrecedence: description: |- Search precedence between local user database and LDAP user database. * `LocalUserDb` - Precedence is given to local user database while searching. * `LDAPUserDb` - Precedence is given to LADP user database while searching. type: string enum: - 'LocalUserDb' - 'LDAPUserDb' default: LocalUserDb x-omitempty: true _0_Idp: # A Relationship to MO iam.Idp $ref: '#/components/schemas/iam.Idp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdp resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ApplianceAccount: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. Groups: # A Relationship to MO iam.LdapGroup description: An array of relationships to iamLdapGroup resources. type: array items: $ref: '#/components/schemas/iam.LdapGroup.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true Providers: # A Relationship to MO iam.LdapProvider description: An array of relationships to iamLdapProvider resources. type: array items: $ref: '#/components/schemas/iam.LdapProvider.Relationship' nullable: 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. The '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.LdapProvider.Response: description: |- The response body of a HTTP GET request for the 'iam.LdapProvider' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.LdapProvider: title: Iam:Ldap Provider description: |- LDAP Provider or LDAP Server for user authentication. x-allOf-name: iam.LdapProvider allOf: - # This 'iam.LdapProvider' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.LdapProvider' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.LdapProvider', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.LdapProvider' ObjectType: enum: - 'iam.LdapProvider' Port: description: |- LDAP Server Port for connection establishment. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true Server: description: |- LDAP Server Address, can be IP address or hostname. type: string x-omitempty: true LdapPolicy: # A Relationship to MO iam.LdapPolicy $ref: '#/components/schemas/iam.LdapPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamLdapPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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. The '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.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' iam.LocalUserPassword: title: Iam:Local User Password description: |- LocalUserPassword type is used for changing local user's password. Caller must send old password in Password field and new password in newPassword field. Intersight will verify the old password and sets the new password if everything is OK. This API must not be used for resetting user's password. x-allOf-name: iam.LocalUserPassword allOf: - # This 'iam.LocalUserPassword' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.LocalUserPassword' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.LocalUserPassword', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.LocalUserPassword' ObjectType: enum: - 'iam.LocalUserPassword' CurrentPassword: description: |- User-entered passsord to be compared to password for change password function. type: string writeOnly: true x-omitempty: true NewPassword: description: |- New password that the user's password should be changed to. type: string writeOnly: true x-omitempty: true Password: description: |- User's current valid passsord. type: string format: byte writeOnly: true x-omitempty: true User: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true iam.OAuthToken.Response: description: |- The response body of a HTTP GET request for the 'iam.OAuthToken' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.OAuthToken: title: OAuth2 Token description: |- The meta data for generating OAuth2 token of a user. It is created when user logged in via OAuth2 using Authorization Code grant and deleted upon logout, expiration timeout or manual deletion. x-allOf-name: iam.OAuthToken allOf: - # This 'iam.OAuthToken' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.OAuthToken' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.OAuthToken', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.OAuthToken' ObjectType: enum: - 'iam.OAuthToken' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AppRegistration: # A Relationship to MO iam.AppRegistration $ref: '#/components/schemas/iam.AppRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAppRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Permission: # A Relationship to MO iam.Permission $ref: '#/components/schemas/iam.Permission.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPermission resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true User: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When 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. The '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.Permission.Response: description: |- The response body of a HTTP GET request for the 'iam.Permission' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'iam.Permission' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Permission' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Permission', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Permission' ObjectType: enum: - 'iam.Permission' Description: description: |- The informative description about each permission. type: string 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,64}$" minLength: 1 maxLength: 64 x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EndPointRoles: # A Relationship to MO iam.EndPointRole description: An array of relationships to iamEndPointRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointRole.Relationship' nullable: true readOnly: true ResourceRoles: # A Relationship to MO iam.ResourceRoles description: An array of relationships to iamResourceRoles resources. type: array items: $ref: '#/components/schemas/iam.ResourceRoles.Relationship' nullable: true x-createOnly: true Roles: # A Relationship to MO iam.Role description: An array of relationships to iamRole resources. type: array items: $ref: '#/components/schemas/iam.Role.Relationship' nullable: true SessionLimits: # A Relationship to MO iam.SessionLimits $ref: '#/components/schemas/iam.SessionLimits.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSessionLimits resource. When the $expand query parameter is specified, the referenced resource is returned inline. UserGroups: # A Relationship to MO iam.UserGroup description: An array of relationships to iamUserGroup resources. type: array items: $ref: '#/components/schemas/iam.UserGroup.Relationship' nullable: true Users: # A Relationship to MO iam.User 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. The '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 allOf: - # This 'iam.PermissionReference' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.PermissionReference' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.PermissionReference', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.PermissionReference' ObjectType: enum: - 'iam.PermissionReference' 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 iam.PermissionToRoles: title: Iam:Permission To Roles description: |- Complex type representing a permission and its associated roles. x-allOf-name: iam.PermissionToRoles allOf: - # This 'iam.PermissionToRoles' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.PermissionToRoles' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.PermissionToRoles', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.PermissionToRoles' ObjectType: enum: - 'iam.PermissionToRoles' Permission: description: |- Permission Id of the object. $ref: '#/components/schemas/cmrf.CmRf' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Roles: type: array items: description: |- Collection of Roles for the Permission. $ref: '#/components/schemas/cmrf.CmRf' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true iam.PrivateKeySpec.Response: description: |- The response body of a HTTP GET request for the 'iam.PrivateKeySpec' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.PrivateKeySpec: title: Iam:Private Key Spec description: |- Parameters used to generate a private key. x-allOf-name: iam.PrivateKeySpec allOf: - # This 'iam.PrivateKeySpec' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.PrivateKeySpec' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.PrivateKeySpec', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.PrivateKeySpec' ObjectType: enum: - 'iam.PrivateKeySpec' Algorithm: description: |- Algorithm used to generate the key pair and algorithm-speicifc parameters, such as RSA modulus size. $ref: '#/components/schemas/pkix.KeyGenerationSpec' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-createOnly: true x-omitempty: true CertificateRequest: # A Relationship to MO iam.CertificateRequest $ref: '#/components/schemas/iam.CertificateRequest.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamCertificateRequest resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'iam.Privilege' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Privilege' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Privilege', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Privilege' ObjectType: enum: - 'iam.Privilege' 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 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true System: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.PrivilegeSet: title: Iam:Privilege Set description: |- A collection of privileges. x-allOf-name: iam.PrivilegeSet allOf: - # This 'iam.PrivilegeSet' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.PrivilegeSet' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.PrivilegeSet', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.PrivilegeSet' ObjectType: enum: - 'iam.PrivilegeSet' Description: description: |- Description of the privilege set. type: string readOnly: true x-omitempty: true Name: description: |- Name of the privilege set. type: string x-createOnly: true x-omitempty: true PrivilegeNames: type: array items: description: |- Names of the privileges in the privilege set. type: string readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true AssociatedPrivilegeSets: # A Relationship to MO iam.PrivilegeSet description: An array of relationships to iamPrivilegeSet resources. type: array items: $ref: '#/components/schemas/iam.PrivilegeSet.Relationship' nullable: true Privileges: # A Relationship to MO iam.Privilege description: An array of relationships to iamPrivilege resources. type: array items: $ref: '#/components/schemas/iam.Privilege.Relationship' nullable: true readOnly: true System: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When 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. The '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.Qualifier.Response: description: |- The response body of a HTTP GET request for the 'iam.Qualifier' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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.Relationship: description: A relationship to the 'iam.Qualifier' resource, or the expanded 'iam.Qualifier' resource, or the 'null' value. x-one-of-name: iam.Qualifier.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/iam.Qualifier' 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: - # This 'iam.Qualifier' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Qualifier' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Qualifier', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Qualifier' ObjectType: enum: - 'iam.Qualifier' 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 Usergroup: # A Relationship to MO iam.UserGroup $ref: '#/components/schemas/iam.UserGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUserGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.ResourceLimits: title: Iam:Resource Limits description: |- The resource limits used to limit resources such as User accounts. x-allOf-name: iam.ResourceLimits allOf: - # This 'iam.ResourceLimits' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.ResourceLimits' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.ResourceLimits', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.ResourceLimits' ObjectType: enum: - 'iam.ResourceLimits' 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.ResourcePermission: title: Iam:Resource Permission description: |- ResourcePermission represents the permissions defined on a resource like organization. x-allOf-name: iam.ResourcePermission allOf: - # This 'iam.ResourcePermission' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.ResourcePermission' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.ResourcePermission', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.ResourcePermission' ObjectType: enum: - 'iam.ResourcePermission' PermissionRoles: type: array items: description: |- Permissions which are associated with the organization and their role mapping. $ref: '#/components/schemas/iam.PermissionToRoles' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true TargetApp: description: |- Name of the service owning the resource. type: string readOnly: true x-omitempty: true Holder: # A Relationship to MO iam.SecurityHolder $ref: '#/components/schemas/iam.SecurityHolder.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSecurityHolder resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Resource: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When 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. The '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.ResourceRoles.Response: description: |- The response body of a HTTP GET request for the 'iam.ResourceRoles' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.ResourceRoles: title: Iam:Resource Roles description: |- ResourceRoles provides a way to specify the roles associated with a resource like organization in a permission which can be assigned to a user or user group. x-allOf-name: iam.ResourceRoles allOf: - # This 'iam.ResourceRoles' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.ResourceRoles' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.ResourceRoles', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.ResourceRoles' ObjectType: enum: - 'iam.ResourceRoles' EndPointRoles: # A Relationship to MO iam.EndPointRole description: An array of relationships to iamEndPointRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointRole.Relationship' nullable: true readOnly: true Permission: # A Relationship to MO iam.Permission $ref: '#/components/schemas/iam.Permission.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPermission resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Resource: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Roles: # A Relationship to MO iam.Role 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'iam.Role' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Role' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Role', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Role' ObjectType: enum: - 'iam.Role' 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 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 Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PrivilegeSets: # A Relationship to MO iam.PrivilegeSet description: An array of relationships to iamPrivilegeSet resources. type: array items: $ref: '#/components/schemas/iam.PrivilegeSet.Relationship' nullable: true readOnly: true System: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When 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. The '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 validation of the incoming request. x-allOf-name: iam.Rule allOf: - # This 'iam.Rule' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.Rule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Rule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Rule' ObjectType: enum: - 'iam.Rule' 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. * `Ip` - The IP address rule type is IP. * `Cidr` - The IP address rule type is CIDR range. * `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 iam.SecurityHolder.Response: description: |- The response body of a HTTP GET request for the 'iam.SecurityHolder' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.SecurityHolder: title: Iam:Security Holder description: |- Holder for organization aggregated permissions and global account permissions. User configures permissions for entire account or subset of organizations and specifies associated roles with each organization. Intersight aggregates all the permissions and stores per organization aggregate permissions in iam.ResourcePermission object. x-allOf-name: iam.SecurityHolder allOf: - # This 'iam.SecurityHolder' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.SecurityHolder' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.SecurityHolder', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.SecurityHolder' ObjectType: enum: - 'iam.SecurityHolder' Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true IpRulesConfiguration: # A Relationship to MO iam.IpAccessManagement $ref: '#/components/schemas/iam.IpAccessManagement.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIpAccessManagement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ResourcePermissions: # A Relationship to MO iam.ResourcePermission 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.ServiceProvider: title: Iam:Service Provider description: |- SAML Service provider related information in Intersight. x-allOf-name: iam.ServiceProvider allOf: - # This 'iam.ServiceProvider' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.ServiceProvider' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.ServiceProvider', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.ServiceProvider' ObjectType: enum: - 'iam.ServiceProvider' 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: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'iam.Session' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.Session' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.Session', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.Session' ObjectType: enum: - 'iam.Session' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true ClientIpAddress: description: |- The user agent IP address from which the session is launched. type: string readOnly: true x-omitempty: true Expiration: description: |- Expiration time for the session. type: string format: date-time 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 Permission: # A Relationship to MO iam.Permission $ref: '#/components/schemas/iam.Permission.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPermission resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true User: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.SessionLimits: title: Iam:Session Limits description: |- The session related configuration limits. x-allOf-name: iam.SessionLimits allOf: - # This 'iam.SessionLimits' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.SessionLimits' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.SessionLimits', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.SessionLimits' ObjectType: enum: - 'iam.SessionLimits' 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 minimum: 300 maximum: 18000 x-omitempty: true MaximumLimit: description: |- The maximum number of sessions allowed in an account. The default value is 128. type: integer format: int64 minimum: 1 maximum: 128 readOnly: true x-omitempty: true PerUserLimit: description: |- The maximum number of sessions allowed per user. Default value is 32. type: integer format: int64 minimum: 1 maximum: 32 readOnly: true 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 minimum: 300 maximum: 31536000 x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Permission: # A Relationship to MO iam.Permission $ref: '#/components/schemas/iam.Permission.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPermission resource. When 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. The '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.SsoSessionAttributes: title: Iam:Sso Session Attributes description: |- Session attributes required to maintain states of SP and IdP. x-allOf-name: iam.SsoSessionAttributes allOf: - # This 'iam.SsoSessionAttributes' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'iam.SsoSessionAttributes' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.SsoSessionAttributes', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.SsoSessionAttributes' ObjectType: enum: - 'iam.SsoSessionAttributes' 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 iam.System.Response: description: |- The response body of a HTTP GET request for the 'iam.System' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.System: title: Iam:System description: |- System is the top level object in the Intersight. All other objects which can be accessed globally are added to system object, like privilege sets and privileges can be shared by multiple roles and privilege sets. x-allOf-name: iam.System allOf: - # This 'iam.System' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.System' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.System', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.System' ObjectType: enum: - 'iam.System' EndPointPrivileges: # A Relationship to MO iam.EndPointPrivilege description: An array of relationships to iamEndPointPrivilege resources. type: array items: $ref: '#/components/schemas/iam.EndPointPrivilege.Relationship' nullable: true readOnly: true EndPointRoles: # A Relationship to MO iam.EndPointRole description: An array of relationships to iamEndPointRole resources. type: array items: $ref: '#/components/schemas/iam.EndPointRole.Relationship' nullable: true readOnly: true Idp: # A Relationship to MO iam.Idp $ref: '#/components/schemas/iam.Idp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdp resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PrivilegeSets: # A Relationship to MO iam.PrivilegeSet description: An array of relationships to iamPrivilegeSet resources. type: array items: $ref: '#/components/schemas/iam.PrivilegeSet.Relationship' nullable: true readOnly: true Privileges: # A Relationship to MO iam.Privilege description: An array of relationships to iamPrivilege resources. type: array items: $ref: '#/components/schemas/iam.Privilege.Relationship' nullable: true readOnly: true Roles: # A Relationship to MO iam.Role description: An array of relationships to iamRole resources. type: array items: $ref: '#/components/schemas/iam.Role.Relationship' nullable: true readOnly: true ServiceProvider: # A Relationship to MO iam.ServiceProvider $ref: '#/components/schemas/iam.ServiceProvider.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamServiceProvider resource. When 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. The '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.TrustPoint.Response: description: |- The response body of a HTTP GET request for the 'iam.TrustPoint' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: title: Iam:Trust Point description: |- To affirm the identity of trusted source. Allows import of third-party CA certificates in X.509 (CER) format. It can be a root CA or an trust chain that leads to a root CA. x-allOf-name: iam.TrustPoint allOf: - # This 'iam.TrustPoint' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.TrustPoint' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.TrustPoint', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.TrustPoint' ObjectType: enum: - 'iam.TrustPoint' Certificates: type: array items: description: |- The collection of certificates in X509 certificate format. This was obtained by parsing the chain property which holds the base 64 encoded chain of certificates. $ref: '#/components/schemas/x509.Certificate' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.User: title: User description: |- The Intersight account user. x-allOf-name: iam.User allOf: - # This 'iam.User' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.User' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.User', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.User' ObjectType: enum: - 'iam.User' 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. 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 FirstName: description: |- First name of the user. This field is populated from the IdP attributes received after authentication. type: string readOnly: true 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. This field is populated from the IdP attributes received after authentication. type: string readOnly: true x-omitempty: true Name: description: |- Name as configured in the IdP. type: string readOnly: true x-omitempty: true UserIdOrEmail: description: |- UserID or email 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: # A Relationship to MO iam.ApiKey description: An array of relationships to iamApiKey resources. type: array items: $ref: '#/components/schemas/iam.ApiKey.Relationship' nullable: true readOnly: true AppRegistrations: # A Relationship to MO iam.AppRegistration description: An array of relationships to iamAppRegistration resources. type: array items: $ref: '#/components/schemas/iam.AppRegistration.Relationship' nullable: true readOnly: true Idp: # A Relationship to MO iam.Idp $ref: '#/components/schemas/iam.Idp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdp resource. When the $expand query parameter is specified, the referenced resource is returned inline. Idpreference: # A Relationship to MO iam.IdpReference $ref: '#/components/schemas/iam.IdpReference.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdpReference resource. When the $expand query parameter is specified, the referenced resource is returned inline. LocalUserPassword: # A Relationship to MO iam.LocalUserPassword $ref: '#/components/schemas/iam.LocalUserPassword.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamLocalUserPassword resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true OauthTokens: # A Relationship to MO iam.OAuthToken description: An array of relationships to iamOAuthToken resources. type: array items: $ref: '#/components/schemas/iam.OAuthToken.Relationship' nullable: true readOnly: true Permissions: # A Relationship to MO iam.Permission description: An array of relationships to iamPermission resources. type: array items: $ref: '#/components/schemas/iam.Permission.Relationship' nullable: true Sessions: # A Relationship to MO iam.Session description: An array of relationships to iamSession resources. type: array items: $ref: '#/components/schemas/iam.Session.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. The '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.UserGroup.Response: description: |- The response body of a HTTP GET request for the 'iam.UserGroup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.UserGroup: title: Iam:User Group description: |- User Group provides a way to assign permissions to a group of users based on the IdP attributes received after authentication. x-allOf-name: iam.UserGroup allOf: - # This 'iam.UserGroup' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.UserGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.UserGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.UserGroup' ObjectType: enum: - 'iam.UserGroup' Name: description: |- The name of the user group which the dynamic user belongs to. type: string x-createOnly: true x-omitempty: true Idp: # A Relationship to MO iam.Idp $ref: '#/components/schemas/iam.Idp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdp resource. When the $expand query parameter is specified, the referenced resource is returned inline. Idpreference: # A Relationship to MO iam.IdpReference $ref: '#/components/schemas/iam.IdpReference.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdpReference resource. When the $expand query parameter is specified, the referenced resource is returned inline. Permissions: # A Relationship to MO iam.Permission description: An array of relationships to iamPermission resources. type: array items: $ref: '#/components/schemas/iam.Permission.Relationship' nullable: true Qualifier: # A Relationship to MO iam.Qualifier $ref: '#/components/schemas/iam.Qualifier.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamQualifier resource. When the $expand query parameter is specified, the referenced resource is returned inline. Users: # A Relationship to MO iam.User 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' iam.UserPreference: title: Iam:User Preference description: |- Holder for UI preferences such as theme, columns. x-allOf-name: iam.UserPreference allOf: - # This 'iam.UserPreference' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'iam.UserPreference' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'iam.UserPreference', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'iam.UserPreference' ObjectType: enum: - 'iam.UserPreference' Preference: description: |- UI preferences of the user. # Property is any value, it may be the null value, an object or array. 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: # A Relationship to MO iam.Idp $ref: '#/components/schemas/iam.Idp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdp resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true IdpReference: # A Relationship to MO iam.IdpReference $ref: '#/components/schemas/iam.IdpReference.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamIdpReference resource. When 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. The '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 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: - # This 'imcconnector.WebUiMessage' class inherits all properties from its parent class connector.AuthMessage. $ref: '#/components/schemas/connector.AuthMessage' - # The definition of all the properties specified in this 'imcconnector.WebUiMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'imcconnector.WebUiMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'imcconnector.WebUiMessage' ObjectType: enum: - 'imcconnector.WebUiMessage' WebUiRequest: description: |- The body content of the UI HTTP request to send to the BMC platform. type: string x-omitempty: true infra.HardwareInfo: title: Infra:Hardware Info description: |- Information about the hardware platform (cpu, memory). x-allOf-name: infra.HardwareInfo allOf: - # This 'infra.HardwareInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'infra.HardwareInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'infra.HardwareInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'infra.HardwareInfo' ObjectType: enum: - 'infra.HardwareInfo' 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 inventory.Base.Relationship: description: A relationship to the 'inventory.Base' resource, or the expanded 'inventory.Base' resource, or the 'null' value. x-one-of-name: inventory.Base.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/inventory.Base' inventory.Base: title: Inventory:Base description: |- Base class for all inventory MOs. x-allOf-name: inventory.Base allOf: - # This 'inventory.Base' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'inventory.Base' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'inventory.Base', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: DeviceMoId: description: |- The database identifier of the registered device of an object. type: string readOnly: true x-omitempty: true Dn: description: |- The Distinguished Name unambiguously identifies an object in the system. type: string readOnly: true x-omitempty: true Rn: description: |- The Relative Name uniquely identifies an object within a given context. type: string readOnly: true x-omitempty: true inventory.DeviceInfo.Response: description: |- The response body of a HTTP GET request for the 'inventory.DeviceInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'inventory.DeviceInfo' resources. x-one-of-name: inventory.DeviceInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/inventory.DeviceInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType inventory.DeviceInfo.Relationship: description: A relationship to the 'inventory.DeviceInfo' resource, or the expanded 'inventory.DeviceInfo' resource, or the 'null' value. x-one-of-name: inventory.DeviceInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/inventory.DeviceInfo' inventory.DeviceInfo: title: Inventory:Device Info description: |- Information pertaining to a Registered Device in starship which is pertinent to Inventory Microservice. x-allOf-name: inventory.DeviceInfo allOf: - # This 'inventory.DeviceInfo' class inherits all properties from its parent class policyinventory.AbstractDeviceInfo. $ref: '#/components/schemas/policyinventory.AbstractDeviceInfo' inventory.DeviceInfo.List: title: List of 'inventory.DeviceInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'inventory.DeviceInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'inventory.DeviceInfo' resources matching the request. type: array items: $ref: '#/components/schemas/inventory.DeviceInfo' nullable: true inventory.DnMoBinding.Response: description: |- The response body of a HTTP GET request for the 'inventory.DnMoBinding' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'inventory.DnMoBinding' resources. x-one-of-name: inventory.DnMoBinding.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/inventory.DnMoBinding.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType inventory.DnMoBinding: title: Inventory:Dn Mo Binding description: |- DnMoBinding provides a binding between a Intersight MO and a UCSM MO which has a DN. x-allOf-name: inventory.DnMoBinding allOf: - # This 'inventory.DnMoBinding' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'inventory.DnMoBinding' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'inventory.DnMoBinding', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'inventory.DnMoBinding' ObjectType: enum: - 'inventory.DnMoBinding' Dn: description: |- The Distinguished Name for this object, used to uniquely identify this object. type: string readOnly: true x-omitempty: true TargetMoId: description: |- The MO ID of the target MO for this particular Distinguished Name (dn). type: string readOnly: true x-omitempty: true TargetMoType: description: |- The type of the target MO for this particular Distinguished Name (dn). type: string readOnly: true x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true inventory.DnMoBinding.List: title: List of 'inventory.DnMoBinding' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'inventory.DnMoBinding' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'inventory.DnMoBinding' resources matching the request. type: array items: $ref: '#/components/schemas/inventory.DnMoBinding' nullable: true inventory.GenericInventory.Response: description: |- The response body of a HTTP GET request for the 'inventory.GenericInventory' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'inventory.GenericInventory' resources. x-one-of-name: inventory.GenericInventory.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/inventory.GenericInventory.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType inventory.GenericInventory.Relationship: description: A relationship to the 'inventory.GenericInventory' resource, or the expanded 'inventory.GenericInventory' resource, or the 'null' value. x-one-of-name: inventory.GenericInventory.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/inventory.GenericInventory' inventory.GenericInventory: title: Inventory:Generic Inventory description: |- Any inventory which is represented as a key / value pair. Example - moInvKv in UCSM representing OS tools running on ESX. x-allOf-name: inventory.GenericInventory allOf: - # This 'inventory.GenericInventory' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'inventory.GenericInventory' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'inventory.GenericInventory', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'inventory.GenericInventory' ObjectType: enum: - 'inventory.GenericInventory' Key: description: |- Key of inventory data for Generic Inventory data set. type: string readOnly: true x-omitempty: true Type: description: |- Type of inventory data for Generic Inventory data set. type: string readOnly: true x-omitempty: true Value: description: |- Value of inventory data for Generic Inventory data set. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryGenericInventoryHolder: # A Relationship to MO inventory.GenericInventoryHolder $ref: '#/components/schemas/inventory.GenericInventoryHolder.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryGenericInventoryHolder resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true inventory.GenericInventory.List: title: List of 'inventory.GenericInventory' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'inventory.GenericInventory' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'inventory.GenericInventory' resources matching the request. type: array items: $ref: '#/components/schemas/inventory.GenericInventory' nullable: true inventory.GenericInventoryHolder.Response: description: |- The response body of a HTTP GET request for the 'inventory.GenericInventoryHolder' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'inventory.GenericInventoryHolder' resources. x-one-of-name: inventory.GenericInventoryHolder.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/inventory.GenericInventoryHolder.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType inventory.GenericInventoryHolder.Relationship: description: A relationship to the 'inventory.GenericInventoryHolder' resource, or the expanded 'inventory.GenericInventoryHolder' resource, or the 'null' value. x-one-of-name: inventory.GenericInventoryHolder.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/inventory.GenericInventoryHolder' inventory.GenericInventoryHolder: title: Inventory:Generic Inventory Holder description: |- A container class for generic inventory. x-allOf-name: inventory.GenericInventoryHolder allOf: - # This 'inventory.GenericInventoryHolder' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'inventory.GenericInventoryHolder' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'inventory.GenericInventoryHolder', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'inventory.GenericInventoryHolder' ObjectType: enum: - 'inventory.GenericInventoryHolder' Endpoint: description: |- The endpoint represented by this holder. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true GenericInventory: # A Relationship to MO inventory.GenericInventory description: An array of relationships to inventoryGenericInventory resources. type: array items: $ref: '#/components/schemas/inventory.GenericInventory.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true inventory.GenericInventoryHolder.List: title: List of 'inventory.GenericInventoryHolder' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'inventory.GenericInventoryHolder' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'inventory.GenericInventoryHolder' resources matching the request. type: array items: $ref: '#/components/schemas/inventory.GenericInventoryHolder' nullable: true inventory.InventoryMo: title: Inventory:Inventory Mo description: |- Complex type representing the inventory MO. x-allOf-name: inventory.InventoryMo allOf: - # This 'inventory.InventoryMo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'inventory.InventoryMo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'inventory.InventoryMo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'inventory.InventoryMo' ObjectType: enum: - 'inventory.InventoryMo' MoDn: description: |- The UCS DN of the MO for which the latest inventory to be fetched. If this property is empty and moId property has the Moid of the MO to be updated, the Moid will be used. If this property is empty and moId is also empty, all the MOs of the given moType will be updated. type: string x-omitempty: true MoId: description: |- The MO id of an MO for which the latest inventory to be fetched. If this property is empty and moDn property has the UCS DN of the MO to be updated, the DN will be used. If this property is empty and moDn is also empty, all the MOs of the given moType will be updated. type: string x-omitempty: true MoType: description: |- The type of the MO for which the latest inventory to be fetched. type: string x-omitempty: true inventory.Request: title: Inventory:Request description: |- Request MO allows the inventory of specific devices to be collected on demand. The inventory can be collected in three levels - all the MOs of a specific device, MOs of specific MO types for a given device or specific MO instances of specific MO types for a given device. These MO instances are used just to collect the requests and not persisted. x-allOf-name: inventory.Request allOf: - # This 'inventory.Request' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'inventory.Request' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'inventory.Request', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'inventory.Request' ObjectType: enum: - 'inventory.Request' Mos: type: array items: description: |- The collection of specific inventory MOs that need to be fetched. The property is optional and if not present then all the MOs of the given device will be fetched. $ref: '#/components/schemas/inventory.InventoryMo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. ipmioverlan.Policy.Response: description: |- The response body of a HTTP GET request for the 'ipmioverlan.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ipmioverlan.Policy' resources. x-one-of-name: ipmioverlan.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ipmioverlan.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ipmioverlan.Policy: title: IPMI Over LAN description: |- Intelligent Platform Management Interface Over LAN Policy. x-allOf-name: ipmioverlan.Policy allOf: - # This 'ipmioverlan.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'ipmioverlan.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ipmioverlan.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ipmioverlan.Policy' ObjectType: enum: - 'ipmioverlan.Policy' Enabled: description: |- State of the IPMI Over LAN service on the endpoint. type: boolean x-omitempty: true EncryptionKey: description: |- The encryption key to use for IPMI communication. It should have an even number of hexadecimal characters and not exceed 40 characters. type: string pattern: "^[a-fA-F0-9]*$" minLength: 0 maxLength: 40 writeOnly: true x-omitempty: true IsEncryptionKeySet: description: |- Indicates whether the value of the 'encryptionKey' property has been set. type: boolean readOnly: true x-omitempty: true Privilege: description: |- The highest privilege level that can be assigned to an IPMI session on a server. * `admin` - Privilege to perform all actions available through IPMI. * `user` - Privilege to perform some functions through IPMI but restriction on performing administrative tasks. * `read-only` - Privilege to view information throught IPMI but restriction on making any changes. type: string enum: - 'admin' - 'user' - 'read-only' default: admin x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true ipmioverlan.Policy.List: title: List of 'ipmioverlan.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ipmioverlan.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ipmioverlan.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/ipmioverlan.Policy' nullable: true ippool.IpBlock: title: Ippool:Ip Block description: |- A block of IPv4 addresses. x-allOf-name: ippool.IpBlock allOf: - # This 'ippool.IpBlock' class inherits all properties from its parent class pool.AbstractBlockType. $ref: '#/components/schemas/pool.AbstractBlockType' - # The definition of all the properties specified in this 'ippool.IpBlock' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.IpBlock', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.IpBlock' ObjectType: enum: - 'ippool.IpBlock' From: description: |- First IPv4 address of the block. type: string pattern: "^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" readOnly: true x-omitempty: true To: description: |- Last IPv4 address of the block. type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" readOnly: true x-omitempty: true ippool.IpLease.Response: description: |- The response body of a HTTP GET request for the 'ippool.IpLease' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ippool.IpLease' resources. x-one-of-name: ippool.IpLease.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ippool.IpLease.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ippool.IpLease.Relationship: description: A relationship to the 'ippool.IpLease' resource, or the expanded 'ippool.IpLease' resource, or the 'null' value. x-one-of-name: ippool.IpLease.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ippool.IpLease' ippool.IpLease: title: Ippool:Ip Lease description: |- IpLease represents an IP address that is allocated from a pool to a specific entity like server profile. x-allOf-name: ippool.IpLease allOf: - # This 'ippool.IpLease' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'ippool.IpLease' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.IpLease', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.IpLease' ObjectType: enum: - 'ippool.IpLease' IpV4Address: description: |- IPv4 Address given as a lease to an external entity like server profiles. type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" readOnly: true x-omitempty: true IpV4Config: description: |- Netmask, Gateway and DNS settings. $ref: '#/components/schemas/ippool.IpV4Config' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. Pool: # A Relationship to MO ippool.Pool $ref: '#/components/schemas/ippool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true PoolMember: # A Relationship to MO ippool.PoolMember $ref: '#/components/schemas/ippool.PoolMember.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolPoolMember resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Universe: # A Relationship to MO ippool.Universe $ref: '#/components/schemas/ippool.Universe.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolUniverse resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Vrf: # A Relationship to MO vrf.Vrf $ref: '#/components/schemas/vrf.Vrf.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vrfVrf resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true ippool.IpLease.List: title: List of 'ippool.IpLease' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ippool.IpLease' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ippool.IpLease' resources matching the request. type: array items: $ref: '#/components/schemas/ippool.IpLease' nullable: true ippool.IpV4Config: title: Ippool:Ip V4 Config description: |- Network interface configuration data for IPv4 interfaces. Netmask, Gateway and DNS settings. x-allOf-name: ippool.IpV4Config allOf: - # This 'ippool.IpV4Config' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'ippool.IpV4Config' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.IpV4Config', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.IpV4Config' ObjectType: enum: - 'ippool.IpV4Config' Gateway: description: |- IP address of the default IPv4 gateway. type: string pattern: "^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" readOnly: true x-omitempty: true Netmask: description: |- A subnet mask is a 32-bit number that masks an IP address and divides the IP address into network address and host address. type: string pattern: "^(((255.){3}(255|254|252|248|240|224|192|128|0+))|((255.){2}(255|254|252|248|240|224|192|128|0+).0)|((255.)(255|254|252|248|240|224|192|128|0+)(.0+){2})|((255|254|252|248|240|224|192|128|0+)(.0+){3}))$" readOnly: true x-omitempty: true PrimaryDns: description: |- IP Address of the primary Domain Name System (DNS) server. type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" readOnly: true x-omitempty: true SecondaryDns: description: |- IP Address of the secondary Domain Name System (DNS) server. type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" readOnly: true x-omitempty: true ippool.Pool.Response: description: |- The response body of a HTTP GET request for the 'ippool.Pool' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ippool.Pool' resources. x-one-of-name: ippool.Pool.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ippool.Pool.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ippool.Pool.Relationship: description: A relationship to the 'ippool.Pool' resource, or the expanded 'ippool.Pool' resource, or the 'null' value. x-one-of-name: ippool.Pool.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ippool.Pool' ippool.Pool: title: Ippool:Pool description: |- Pool represents a collection of IPv4 addresses that can be allocated to other configuration entities like server profiles. x-allOf-name: ippool.Pool allOf: - # This 'ippool.Pool' class inherits all properties from its parent class pool.AbstractPool. $ref: '#/components/schemas/pool.AbstractPool' - # The definition of all the properties specified in this 'ippool.Pool' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.Pool', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.Pool' ObjectType: enum: - 'ippool.Pool' IpV4Blocks: type: array items: description: |- Collection of IPv4 blocks. $ref: '#/components/schemas/ippool.IpBlock' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IpV4Config: description: |- Netmask, Gateway and DNS settings for IPv4 addresses. $ref: '#/components/schemas/ippool.IpV4Config' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-createOnly: true x-omitempty: true V4Assigned: description: |- Number of IPv4 addresses currently in use. type: integer format: int64 readOnly: true x-omitempty: true V4Size: description: |- Number of IPv4 addresses in this pool. type: integer format: int64 readOnly: true x-omitempty: true V6Assigned: description: |- Number of IPv6 addresses currently in use. type: integer format: int64 readOnly: true x-omitempty: true V6Size: description: |- Number of IPv6 addresses in this pool. type: integer format: int64 readOnly: true x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true ShadowPools: # A Relationship to MO ippool.ShadowPool description: An array of relationships to ippoolShadowPool resources. type: array items: $ref: '#/components/schemas/ippool.ShadowPool.Relationship' nullable: true readOnly: true ippool.Pool.List: title: List of 'ippool.Pool' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ippool.Pool' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ippool.Pool' resources matching the request. type: array items: $ref: '#/components/schemas/ippool.Pool' nullable: true ippool.PoolMember.Response: description: |- The response body of a HTTP GET request for the 'ippool.PoolMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ippool.PoolMember' resources. x-one-of-name: ippool.PoolMember.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ippool.PoolMember.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ippool.PoolMember.Relationship: description: A relationship to the 'ippool.PoolMember' resource, or the expanded 'ippool.PoolMember' resource, or the 'null' value. x-one-of-name: ippool.PoolMember.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ippool.PoolMember' ippool.PoolMember: title: Ippool:Pool Member description: |- PoolMember represents a single IPv4 address that is part of a pool. x-allOf-name: ippool.PoolMember allOf: - # This 'ippool.PoolMember' class inherits all properties from its parent class pool.AbstractPoolMember. $ref: '#/components/schemas/pool.AbstractPoolMember' - # The definition of all the properties specified in this 'ippool.PoolMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.PoolMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.PoolMember' ObjectType: enum: - 'ippool.PoolMember' IpV4Address: description: |- IPv4 Address of this pool member. type: string pattern: "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. IpV4Block: # A Relationship to MO ippool.ShadowBlock $ref: '#/components/schemas/ippool.ShadowBlock.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolShadowBlock resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Peer: # A Relationship to MO ippool.IpLease $ref: '#/components/schemas/ippool.IpLease.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolIpLease resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Pool: # A Relationship to MO ippool.ShadowPool $ref: '#/components/schemas/ippool.ShadowPool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolShadowPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ippool.PoolMember.List: title: List of 'ippool.PoolMember' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ippool.PoolMember' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ippool.PoolMember' resources matching the request. type: array items: $ref: '#/components/schemas/ippool.PoolMember' nullable: true ippool.ShadowBlock.Response: description: |- The response body of a HTTP GET request for the 'ippool.ShadowBlock' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ippool.ShadowBlock' resources. x-one-of-name: ippool.ShadowBlock.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ippool.ShadowBlock.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ippool.ShadowBlock.Relationship: description: A relationship to the 'ippool.ShadowBlock' resource, or the expanded 'ippool.ShadowBlock' resource, or the 'null' value. x-one-of-name: ippool.ShadowBlock.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ippool.ShadowBlock' ippool.ShadowBlock: title: Ippool:Shadow Block description: |- A block of Contiguous IP addresses that are part of a shadow pool. x-allOf-name: ippool.ShadowBlock allOf: - # This 'ippool.ShadowBlock' class inherits all properties from its parent class pool.AbstractBlock. $ref: '#/components/schemas/pool.AbstractBlock' - # The definition of all the properties specified in this 'ippool.ShadowBlock' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.ShadowBlock', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.ShadowBlock' ObjectType: enum: - 'ippool.ShadowBlock' IpV4Block: description: |- A Block of IPv4 addresses. $ref: '#/components/schemas/ippool.IpBlock' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Pool: # A Relationship to MO ippool.ShadowPool $ref: '#/components/schemas/ippool.ShadowPool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolShadowPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ippool.ShadowBlock.List: title: List of 'ippool.ShadowBlock' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ippool.ShadowBlock' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ippool.ShadowBlock' resources matching the request. type: array items: $ref: '#/components/schemas/ippool.ShadowBlock' nullable: true ippool.ShadowPool.Response: description: |- The response body of a HTTP GET request for the 'ippool.ShadowPool' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ippool.ShadowPool' resources. x-one-of-name: ippool.ShadowPool.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ippool.ShadowPool.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ippool.ShadowPool.Relationship: description: A relationship to the 'ippool.ShadowPool' resource, or the expanded 'ippool.ShadowPool' resource, or the 'null' value. x-one-of-name: ippool.ShadowPool.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ippool.ShadowPool' ippool.ShadowPool: title: Ippool:Shadow Pool description: |- Shadow Pool is a tracking object created on behalf of an IP pool, for each VRF. x-allOf-name: ippool.ShadowPool allOf: - # This 'ippool.ShadowPool' class inherits all properties from its parent class pool.AbstractPool. $ref: '#/components/schemas/pool.AbstractPool' - # The definition of all the properties specified in this 'ippool.ShadowPool' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.ShadowPool', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.ShadowPool' ObjectType: enum: - 'ippool.ShadowPool' IpV4Blocks: type: array items: description: |- Collection of IPv4 Blocks. $ref: '#/components/schemas/ippool.IpBlock' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IpV4Config: description: |- Netmask, Gateway and DNS settings for IPv4 addresses. $ref: '#/components/schemas/ippool.IpV4Config' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true V4Assigned: description: |- Number of IPv4 addresses currently in use. type: integer format: int64 readOnly: true x-omitempty: true V4Size: description: |- Number of IPv4 addresses in this pool. type: integer format: int64 readOnly: true x-omitempty: true V6Assigned: description: |- Number of IPv6 addresses currently in use. type: integer format: int64 readOnly: true x-omitempty: true V6Size: description: |- Number of IPv6 addresses in this pool. type: integer format: int64 readOnly: true x-omitempty: true Pool: # A Relationship to MO ippool.Pool $ref: '#/components/schemas/ippool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a ippoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true V4BlockHeads: # A Relationship to MO ippool.ShadowBlock description: An array of relationships to ippoolShadowBlock resources. type: array items: $ref: '#/components/schemas/ippool.ShadowBlock.Relationship' nullable: true readOnly: true Vrf: # A Relationship to MO vrf.Vrf $ref: '#/components/schemas/vrf.Vrf.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vrfVrf resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ippool.ShadowPool.List: title: List of 'ippool.ShadowPool' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ippool.ShadowPool' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ippool.ShadowPool' resources matching the request. type: array items: $ref: '#/components/schemas/ippool.ShadowPool' nullable: true ippool.Universe.Response: description: |- The response body of a HTTP GET request for the 'ippool.Universe' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ippool.Universe' resources. x-one-of-name: ippool.Universe.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ippool.Universe.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ippool.Universe.Relationship: description: A relationship to the 'ippool.Universe' resource, or the expanded 'ippool.Universe' resource, or the 'null' value. x-one-of-name: ippool.Universe.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/ippool.Universe' ippool.Universe: title: Ippool:Universe description: |- Universe represents a book keeping container to keep track of all IP Addresses for a given VRF. x-allOf-name: ippool.Universe allOf: - # This 'ippool.Universe' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'ippool.Universe' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ippool.Universe', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ippool.Universe' ObjectType: enum: - 'ippool.Universe' Vrf: # A Relationship to MO vrf.Vrf $ref: '#/components/schemas/vrf.Vrf.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vrfVrf resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ippool.Universe.List: title: List of 'ippool.Universe' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ippool.Universe' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ippool.Universe' resources matching the request. type: array items: $ref: '#/components/schemas/ippool.Universe' nullable: true kvm.KvmSession.Response: description: |- The response body of a HTTP GET request for the 'kvm.KvmSession' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'kvm.KvmSession' resources. x-one-of-name: kvm.KvmSession.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/kvm.KvmSession.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType kvm.KvmSession: title: Kvm:Kvm Session description: |- API to launch the KVM Session. x-allOf-name: kvm.KvmSession allOf: - # This 'kvm.KvmSession' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'kvm.KvmSession' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'kvm.KvmSession', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'kvm.KvmSession' ObjectType: enum: - 'kvm.KvmSession' KvmMuxUrl: description: |- The URL of the KVM MUX to connect to. type: string readOnly: true x-omitempty: true Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Server: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. kvm.KvmSession.List: title: List of 'kvm.KvmSession' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'kvm.KvmSession' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'kvm.KvmSession' resources matching the request. type: array items: $ref: '#/components/schemas/kvm.KvmSession' nullable: true kvm.Policy.Response: description: |- The response body of a HTTP GET request for the 'kvm.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'kvm.Policy' resources. x-one-of-name: kvm.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/kvm.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType kvm.Policy: title: Virtual KVM description: |- Policy to configure KVM Launch settings. x-allOf-name: kvm.Policy allOf: - # This 'kvm.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'kvm.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'kvm.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'kvm.Policy' ObjectType: enum: - 'kvm.Policy' EnableLocalServerVideo: description: |- If enabled, displays KVM session on any monitor attached to the server. type: boolean x-omitempty: true EnableVideoEncryption: description: |- If enabled, encrypts all video information sent through KVM. type: boolean x-omitempty: true Enabled: description: |- State of the vKVM service on the endpoint. type: boolean x-omitempty: true MaximumSessions: description: |- The maximum number of concurrent KVM sessions allowed. type: integer format: int64 minimum: 1 maximum: 4 x-omitempty: true RemotePort: description: |- The port used for KVM communication. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true kvm.Policy.List: title: List of 'kvm.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'kvm.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'kvm.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/kvm.Policy' nullable: true license.AccountLicenseData.Response: description: |- The response body of a HTTP GET request for the 'license.AccountLicenseData' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' license.AccountLicenseData: title: License:Account License Data description: |- License information for an account. x-allOf-name: license.AccountLicenseData allOf: - # This 'license.AccountLicenseData' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'license.AccountLicenseData' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'license.AccountLicenseData', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'license.AccountLicenseData' ObjectType: enum: - 'license.AccountLicenseData' 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 user. * `Base` - Base as a License type. It is default license type. * `Essential` - Essential as a License type. * `Standard` - Standard as a License type. * `Advantage` - Advantage as a License type. * `Premier` - Premier as a License type. type: string enum: - 'Base' - 'Essential' - 'Standard' - 'Advantage' - 'Premier' 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. * `Base` - Base as a License type. It is default license type. * `Essential` - Essential as a License type. * `Standard` - Standard as a License type. * `Advantage` - Advantage as a License type. * `Premier` - Premier as a License type. type: string enum: - 'Base' - 'Essential' - 'Standard' - 'Advantage' - 'Premier' default: Base 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 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. CustomerOp: # A Relationship to MO license.CustomerOp $ref: '#/components/schemas/license.CustomerOp.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a licenseCustomerOp resource. When the $expand query parameter is specified, the referenced resource is returned inline. Licenseinfos: # A Relationship to MO license.LicenseInfo description: An array of relationships to licenseLicenseInfo resources. type: array items: $ref: '#/components/schemas/license.LicenseInfo.Relationship' nullable: true SmartlicenseToken: # A Relationship to MO license.SmartlicenseToken $ref: '#/components/schemas/license.SmartlicenseToken.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a licenseSmartlicenseToken resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' license.CustomerOp: title: License:Customer Op description: |- Customer operation object to refresh the registration or re-authenticate, pre-created. x-allOf-name: license.CustomerOp allOf: - # This 'license.CustomerOp' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'license.CustomerOp' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'license.CustomerOp', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'license.CustomerOp' ObjectType: enum: - 'license.CustomerOp' ActiveAdmin: description: |- The license administrative state. Set this property to 'true' to activate the license entitlements. 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: # A Relationship to MO license.AccountLicenseData $ref: '#/components/schemas/license.AccountLicenseData.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a licenseAccountLicenseData resource. When 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. The '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.LicenseInfo.Response: description: |- The response body of a HTTP GET request for the 'license.LicenseInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' license.LicenseInfo: title: License:License Info description: |- License state information for a specific license entitlement. Essentials license entitlement is supported currently. licenseState attribute is used for license enforcement. When license state is one of TrialPeriod, Compliance, or OutOfCompliance, the feature set defined for the license entitlement is granted to the customer. x-allOf-name: license.LicenseInfo allOf: - # This 'license.LicenseInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'license.LicenseInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'license.LicenseInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'license.LicenseInfo' ObjectType: enum: - 'license.LicenseInfo' ActiveAdmin: description: |- The license administrative state. Set this property to 'true' to activate the license entitlements. type: boolean 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. The 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 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 LicenseCount: description: |- The total number of devices claimed in the Intersight account. type: integer format: int64 readOnly: true x-omitempty: true LicenseState: description: |- The license state defined by Intersight. The value may be one of NotLicensed, TrialPeriod, OutOfCompliance, Compliance, GraceExpired, or TrialExpired. * `NotLicensed` - The license token is neither activated nor registered. * `GraceExpired` - The license grace period has expired. * `TrialPeriod` - The 90 days of trial period. * `OutOfCompliance` - The license is out of compliance. * `Compliance` - The license is in compliance. * `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. For example, this property may be set to 'Essential'. * `Base` - Base as a License type. It is default license type. * `Essential` - Essential as a License type. * `Standard` - Standard as a License type. * `Advantage` - Advantage as a License type. * `Premier` - Premier as a License type. type: string enum: - 'Base' - 'Essential' - 'Standard' - 'Advantage' - 'Premier' default: Base 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 TrialAdmin: description: |- The administrative state of the trial license. When the LicenseState is set to 'NotLicensed', 'trialAdmin' can be set to true to start the trial period, i.e. licenseState is set to be TrialPeriod. type: boolean readOnly: true x-omitempty: true AccountLicenseData: # A Relationship to MO license.AccountLicenseData $ref: '#/components/schemas/license.AccountLicenseData.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a licenseAccountLicenseData resource. When 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. The '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.LicenseReservationOp.Response: description: |- The response body of a HTTP GET request for the 'license.LicenseReservationOp' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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.Relationship: description: A relationship to the 'license.LicenseReservationOp' resource, or the expanded 'license.LicenseReservationOp' resource, or the 'null' value. x-one-of-name: license.LicenseReservationOp.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/license.LicenseReservationOp' license.LicenseReservationOp: title: License:License Reservation Op description: |- Customer operation object to request reservation code. x-allOf-name: license.LicenseReservationOp allOf: - # This 'license.LicenseReservationOp' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'license.LicenseReservationOp' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'license.LicenseReservationOp', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'license.LicenseReservationOp' ObjectType: enum: - 'license.LicenseReservationOp' 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' license.SmartlicenseToken: title: License:Smartlicense Token description: |- SmartlicenseToken collection stores license registration tokens. x-allOf-name: license.SmartlicenseToken allOf: - # This 'license.SmartlicenseToken' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'license.SmartlicenseToken' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'license.SmartlicenseToken', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'license.SmartlicenseToken' ObjectType: enum: - 'license.SmartlicenseToken' Token: description: |- Smart license registration token. type: string x-omitempty: true AccountLicenseData: # A Relationship to MO license.AccountLicenseData $ref: '#/components/schemas/license.AccountLicenseData.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a licenseAccountLicenseData resource. When 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. The '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 ls.ServiceProfile.Response: description: |- The response body of a HTTP GET request for the 'ls.ServiceProfile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ls.ServiceProfile' resources. x-one-of-name: ls.ServiceProfile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ls.ServiceProfile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ls.ServiceProfile: title: Ls:Service Profile description: |- Logical Profile that can be associated to a physical server. x-allOf-name: ls.ServiceProfile allOf: - # This 'ls.ServiceProfile' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'ls.ServiceProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ls.ServiceProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ls.ServiceProfile' ObjectType: enum: - 'ls.ServiceProfile' AssignState: description: |- Assignment state of the service profile. type: string readOnly: true x-omitempty: true AssocState: description: |- Association state of the service profile. type: string readOnly: true x-omitempty: true AssociatedServer: description: |- Server to which the UCS Manager service profile is associated to. type: string readOnly: true x-omitempty: true ConfigState: description: |- Configuration state of the service profile. type: string readOnly: true x-omitempty: true Name: description: |- Name of the UCS Manager service profile. type: string readOnly: true x-omitempty: true OperState: description: |- Operational state of the service profile. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ls.ServiceProfile.List: title: List of 'ls.ServiceProfile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ls.ServiceProfile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ls.ServiceProfile' resources matching the request. type: array items: $ref: '#/components/schemas/ls.ServiceProfile' nullable: true macpool.Block: title: Macpool:Block description: |- Block of MAC identifiers. x-allOf-name: macpool.Block allOf: - # This 'macpool.Block' class inherits all properties from its parent class pool.AbstractBlockType. $ref: '#/components/schemas/pool.AbstractBlockType' - # The definition of all the properties specified in this 'macpool.Block' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'macpool.Block', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'macpool.Block' ObjectType: enum: - 'macpool.Block' From: description: |- Starting address of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx. To ensure uniqueness of MACs in the LAN fabric, you are strongly encouraged to use the following MAC prefix 00:25:B5:xx:xx:xx. type: string x-omitempty: true To: description: |- Ending address of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx. type: string x-omitempty: true macpool.IdBlock.Response: description: |- The response body of a HTTP GET request for the 'macpool.IdBlock' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'macpool.IdBlock' resources. x-one-of-name: macpool.IdBlock.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/macpool.IdBlock.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType macpool.IdBlock.Relationship: description: A relationship to the 'macpool.IdBlock' resource, or the expanded 'macpool.IdBlock' resource, or the 'null' value. x-one-of-name: macpool.IdBlock.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/macpool.IdBlock' macpool.IdBlock: title: Macpool:Id Block description: |- A block of contiguous MAC addresses that are part of a pool. x-allOf-name: macpool.IdBlock allOf: - # This 'macpool.IdBlock' class inherits all properties from its parent class pool.AbstractBlock. $ref: '#/components/schemas/pool.AbstractBlock' - # The definition of all the properties specified in this 'macpool.IdBlock' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'macpool.IdBlock', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'macpool.IdBlock' ObjectType: enum: - 'macpool.IdBlock' MacBlock: description: |- A Block of MAC Addresses. $ref: '#/components/schemas/macpool.Block' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Pool: # A Relationship to MO macpool.Pool $ref: '#/components/schemas/macpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true macpool.IdBlock.List: title: List of 'macpool.IdBlock' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'macpool.IdBlock' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'macpool.IdBlock' resources matching the request. type: array items: $ref: '#/components/schemas/macpool.IdBlock' nullable: true macpool.Lease.Response: description: |- The response body of a HTTP GET request for the 'macpool.Lease' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'macpool.Lease' resources. x-one-of-name: macpool.Lease.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/macpool.Lease.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType macpool.Lease.Relationship: description: A relationship to the 'macpool.Lease' resource, or the expanded 'macpool.Lease' resource, or the 'null' value. x-one-of-name: macpool.Lease.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/macpool.Lease' macpool.Lease: title: Macpool:Lease description: |- Lease represents a single MAC address that is part of the universe, allocated either from a pool or through static assignment. x-allOf-name: macpool.Lease allOf: - # This 'macpool.Lease' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'macpool.Lease' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'macpool.Lease', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'macpool.Lease' ObjectType: enum: - 'macpool.Lease' MacAddress: description: |- MAC address allocated for pool-based allocation. type: string x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. Pool: # A Relationship to MO macpool.Pool $ref: '#/components/schemas/macpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true PoolMember: # A Relationship to MO macpool.PoolMember $ref: '#/components/schemas/macpool.PoolMember.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolPoolMember resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Universe: # A Relationship to MO macpool.Universe $ref: '#/components/schemas/macpool.Universe.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolUniverse resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true macpool.Lease.List: title: List of 'macpool.Lease' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'macpool.Lease' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'macpool.Lease' resources matching the request. type: array items: $ref: '#/components/schemas/macpool.Lease' nullable: true macpool.Pool.Response: description: |- The response body of a HTTP GET request for the 'macpool.Pool' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'macpool.Pool' resources. x-one-of-name: macpool.Pool.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/macpool.Pool.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType macpool.Pool.Relationship: description: A relationship to the 'macpool.Pool' resource, or the expanded 'macpool.Pool' resource, or the 'null' value. x-one-of-name: macpool.Pool.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/macpool.Pool' macpool.Pool: title: Macpool:Pool description: |- Pool represents a collection of MAC addresses that can be allocated to VNICs of a server profile. x-allOf-name: macpool.Pool allOf: - # This 'macpool.Pool' class inherits all properties from its parent class pool.AbstractPool. $ref: '#/components/schemas/pool.AbstractPool' - # The definition of all the properties specified in this 'macpool.Pool' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'macpool.Pool', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'macpool.Pool' ObjectType: enum: - 'macpool.Pool' MacBlocks: type: array items: description: |- Collection of MAC blocks. $ref: '#/components/schemas/macpool.Block' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 BlockHeads: # A Relationship to MO macpool.IdBlock description: An array of relationships to macpoolIdBlock resources. type: array items: $ref: '#/components/schemas/macpool.IdBlock.Relationship' nullable: true readOnly: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true macpool.Pool.List: title: List of 'macpool.Pool' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'macpool.Pool' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'macpool.Pool' resources matching the request. type: array items: $ref: '#/components/schemas/macpool.Pool' nullable: true macpool.PoolMember.Response: description: |- The response body of a HTTP GET request for the 'macpool.PoolMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'macpool.PoolMember' resources. x-one-of-name: macpool.PoolMember.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/macpool.PoolMember.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType macpool.PoolMember.Relationship: description: A relationship to the 'macpool.PoolMember' resource, or the expanded 'macpool.PoolMember' resource, or the 'null' value. x-one-of-name: macpool.PoolMember.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/macpool.PoolMember' macpool.PoolMember: title: Macpool:Pool Member description: |- PoolMember represents a single MAC address that is part of a pool. x-allOf-name: macpool.PoolMember allOf: - # This 'macpool.PoolMember' class inherits all properties from its parent class pool.AbstractPoolMember. $ref: '#/components/schemas/pool.AbstractPoolMember' - # The definition of all the properties specified in this 'macpool.PoolMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'macpool.PoolMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'macpool.PoolMember' ObjectType: enum: - 'macpool.PoolMember' MacAddress: description: |- MAC Address of this pool member. type: string x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. BlockHead: # A Relationship to MO macpool.IdBlock $ref: '#/components/schemas/macpool.IdBlock.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolIdBlock resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Peer: # A Relationship to MO macpool.Lease $ref: '#/components/schemas/macpool.Lease.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolLease resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Pool: # A Relationship to MO macpool.Pool $ref: '#/components/schemas/macpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true macpool.PoolMember.List: title: List of 'macpool.PoolMember' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'macpool.PoolMember' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'macpool.PoolMember' resources matching the request. type: array items: $ref: '#/components/schemas/macpool.PoolMember' nullable: true macpool.Universe.Response: description: |- The response body of a HTTP GET request for the 'macpool.Universe' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'macpool.Universe' resources. x-one-of-name: macpool.Universe.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/macpool.Universe.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType macpool.Universe.Relationship: description: A relationship to the 'macpool.Universe' resource, or the expanded 'macpool.Universe' resource, or the 'null' value. x-one-of-name: macpool.Universe.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/macpool.Universe' macpool.Universe: title: Macpool:Universe description: |- Universe represents a book keeping container to keep track of all IDs for a given account and pool type. x-allOf-name: macpool.Universe allOf: - # This 'macpool.Universe' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'macpool.Universe' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'macpool.Universe', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'macpool.Universe' ObjectType: enum: - 'macpool.Universe' Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true macpool.Universe.List: title: List of 'macpool.Universe' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'macpool.Universe' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'macpool.Universe' resources matching the request. type: array items: $ref: '#/components/schemas/macpool.Universe' nullable: true management.Controller.Response: description: |- The response body of a HTTP GET request for the 'management.Controller' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'management.Controller' resources. x-one-of-name: management.Controller.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/management.Controller.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType management.Controller.Relationship: description: A relationship to the 'management.Controller' resource, or the expanded 'management.Controller' resource, or the 'null' value. x-one-of-name: management.Controller.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/management.Controller' management.Controller: title: Management:Controller description: |- A specialized service processor that monitors the physical state of a server, using sensors and communicating with the system administrator through an independent connection. x-allOf-name: management.Controller allOf: - # This 'management.Controller' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'management.Controller' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'management.Controller', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'management.Controller' ObjectType: enum: - 'management.Controller' Model: description: |- Model of the endpoint that houses the management controller. type: string readOnly: true x-omitempty: true AdapterUnit: # A Relationship to MO adapter.Unit $ref: '#/components/schemas/adapter.Unit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a adapterUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentIoCardBase: # A Relationship to MO equipment.IoCardBase $ref: '#/components/schemas/equipment.IoCardBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentIoCardBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. EquipmentSharedIoModule: # A Relationship to MO equipment.SharedIoModule $ref: '#/components/schemas/equipment.SharedIoModule.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSharedIoModule resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentSystemIoController: # A Relationship to MO equipment.SystemIoController $ref: '#/components/schemas/equipment.SystemIoController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSystemIoController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ManagementInterfaces: # A Relationship to MO management.Interface description: An array of relationships to managementInterface resources. type: array items: $ref: '#/components/schemas/management.Interface.Relationship' nullable: true readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningFirmware: # A Relationship to MO firmware.RunningFirmware description: An array of relationships to firmwareRunningFirmware resources. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' nullable: true readOnly: true StorageSasExpander: # A Relationship to MO storage.SasExpander $ref: '#/components/schemas/storage.SasExpander.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageSasExpander resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true TopSystem: # A Relationship to MO top.System $ref: '#/components/schemas/top.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a topSystem resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true management.Controller.List: title: List of 'management.Controller' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'management.Controller' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'management.Controller' resources matching the request. type: array items: $ref: '#/components/schemas/management.Controller' nullable: true management.Entity.Response: description: |- The response body of a HTTP GET request for the 'management.Entity' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'management.Entity' resources. x-one-of-name: management.Entity.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/management.Entity.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType management.Entity.Relationship: description: A relationship to the 'management.Entity' resource, or the expanded 'management.Entity' resource, or the 'null' value. x-one-of-name: management.Entity.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/management.Entity' management.Entity: title: Management:Entity description: |- Logical representation that captures the role of each Fabric Interconnect in UCS Manager. x-allOf-name: management.Entity allOf: - # This 'management.Entity' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'management.Entity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'management.Entity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'management.Entity' ObjectType: enum: - 'management.Entity' ClusterLinkState: description: |- Cluster link state between the Fabric Interconnects. type: string readOnly: true x-omitempty: true ClusterReadiness: description: |- Cluster readiness of the Fabric Interconnect. type: string readOnly: true x-omitempty: true ClusterState: description: |- Cluster state of the Fabric Interconnect. type: string readOnly: true x-omitempty: true EntityId: description: |- Identity of the Fabric Interconnect - A/B. type: string readOnly: true x-omitempty: true Leadership: description: |- Role (Primary / Subordinate) of the Fabric Interconnect. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true management.Entity.List: title: List of 'management.Entity' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'management.Entity' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'management.Entity' resources matching the request. type: array items: $ref: '#/components/schemas/management.Entity' nullable: true management.Interface.Response: description: |- The response body of a HTTP GET request for the 'management.Interface' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'management.Interface' resources. x-one-of-name: management.Interface.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/management.Interface.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType management.Interface.Relationship: description: A relationship to the 'management.Interface' resource, or the expanded 'management.Interface' resource, or the 'null' value. x-one-of-name: management.Interface.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/management.Interface' management.Interface: title: Management:Interface description: |- Interface that provides access to the management controller. x-allOf-name: management.Interface allOf: - # This 'management.Interface' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'management.Interface' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'management.Interface', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'management.Interface' ObjectType: enum: - 'management.Interface' Gateway: description: |- Default gateway for the interface. type: string readOnly: true x-omitempty: true HostName: description: |- Hostname configured for the interface. type: string x-omitempty: true IpAddress: description: |- IP address of the interface. type: string readOnly: true x-omitempty: true Ipv4Address: description: |- IPv4 address of the interface. type: string readOnly: true x-omitempty: true Ipv4Gateway: description: |- IPv4 default gateway for the interface. type: string readOnly: true x-omitempty: true Ipv4Mask: description: |- IPv4 Netmask for the interface. type: string readOnly: true x-omitempty: true Ipv6Address: description: |- IPv6 address of the interface. type: string x-omitempty: true Ipv6Gateway: description: |- IPv6 default gateway for the interface. type: string x-omitempty: true Ipv6Prefix: description: |- IPv6 prefix for the interface. type: integer format: int64 x-omitempty: true MacAddress: description: |- MAC address configured for the interface. type: string readOnly: true x-omitempty: true Mask: description: |- Netmask for the interface. type: string readOnly: true x-omitempty: true SwitchId: description: |- Switch Id connected to the interface. type: string x-omitempty: true UemConnStatus: description: |- The event channel connection status for the interface. type: string x-omitempty: true VirtualHostName: description: |- Virtual hostname configured for the interface in case of clustered environment. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ManagementController: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true management.Interface.List: title: List of 'management.Interface' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'management.Interface' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'management.Interface' resources matching the request. type: array items: $ref: '#/components/schemas/management.Interface' nullable: true memory.AbstractUnit: title: Memory:Abstract Unit description: |- Abstract class for all memory units. x-allOf-name: memory.AbstractUnit allOf: - # This 'memory.AbstractUnit' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'memory.AbstractUnit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.AbstractUnit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AdminState: description: |- This represents the administrative state of the memory unit on a server. type: string readOnly: true x-omitempty: true ArrayId: description: |- This represents the memory array to which the memory unit belongs to. type: integer format: int64 readOnly: true x-omitempty: true Bank: description: |- This represents the memory bank of the memory unit on a server. type: integer format: int64 readOnly: true x-omitempty: true Capacity: description: |- This represents the memory capacity in MiB of the memory unit on a server. type: string readOnly: true x-omitempty: true Clock: description: |- This represents the clock of the memory unit on a server. type: string readOnly: true x-omitempty: true FormFactor: description: |- This represents the form factor of the memory unit on a server. type: string readOnly: true x-omitempty: true Latency: description: |- This represents the latency of the memory unit on a server. type: string readOnly: true x-omitempty: true Location: description: |- This represents the location of the memory unit on a server. type: string readOnly: true x-omitempty: true OperPowerState: description: |- This represents the operational power state of the memory unit on a server. type: string readOnly: true x-omitempty: true OperState: description: |- This represents the operational state of the memory unit on a server. type: string readOnly: true x-omitempty: true Operability: description: |- This represents the operability of the memory unit on a server. type: string readOnly: true x-omitempty: true Presence: description: |- This represents the presence state of the memory unit on a server. type: string readOnly: true x-omitempty: true Set: description: |- This represents the set of the memory unit on a server. type: integer format: int64 readOnly: true x-omitempty: true Speed: description: |- This represents the speed of the memory unit on a server. type: string readOnly: true x-omitempty: true Thermal: description: |- This represents the thremal state of the memory unit on a server. type: string readOnly: true x-omitempty: true Type: description: |- This represents the memory type of the memory unit on a server. type: string readOnly: true x-omitempty: true Visibility: description: |- This represents the visibility of the memory unit on a server. type: string readOnly: true x-omitempty: true Width: description: |- This represents the width of the memory unit on a server. type: string readOnly: true x-omitempty: true memory.Array.Response: description: |- The response body of a HTTP GET request for the 'memory.Array' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.Array' resources. x-one-of-name: memory.Array.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.Array.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.Array.Relationship: description: A relationship to the 'memory.Array' resource, or the expanded 'memory.Array' resource, or the 'null' value. x-one-of-name: memory.Array.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.Array' memory.Array: title: Memory:Array description: |- Holder housing multiple memory units. x-allOf-name: memory.Array allOf: - # This 'memory.Array' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'memory.Array' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.Array', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.Array' ObjectType: enum: - 'memory.Array' ArrayId: description: |- The instance number of the memory array. type: integer format: int64 readOnly: true x-omitempty: true CpuId: description: |- ID of the CPU that access this memory array. type: integer format: int64 readOnly: true x-omitempty: true CurrentCapacity: description: |- Current capacity of all the memory units on a server. type: string readOnly: true x-omitempty: true ErrorCorrection: description: |- The primary hardware error detection or correction method supported by the memory array. type: string readOnly: true x-omitempty: true MaxCapacity: description: |- Maximum capacity of all the memory units on a server. type: string readOnly: true x-omitempty: true MaxDevices: description: |- The maximum number of slots or sockets available for memory devices in the memory array. type: string readOnly: true x-omitempty: true OperPowerState: description: |- The power state indicator of the memory array. type: string readOnly: true x-omitempty: true Presence: description: |- The presence of atleast one memory device in the array. Valid values are 'equipped' and 'absent'. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PersistentMemoryUnits: # A Relationship to MO memory.PersistentMemoryUnit description: An array of relationships to memoryPersistentMemoryUnit resources. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryUnit.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Units: # A Relationship to MO memory.Unit description: An array of relationships to memoryUnit resources. type: array items: $ref: '#/components/schemas/memory.Unit.Relationship' nullable: true readOnly: true memory.Array.List: title: List of 'memory.Array' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.Array' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.Array' resources matching the request. type: array items: $ref: '#/components/schemas/memory.Array' nullable: true memory.PersistentMemoryConfigResult.Response: description: |- The response body of a HTTP GET request for the 'memory.PersistentMemoryConfigResult' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.PersistentMemoryConfigResult' resources. x-one-of-name: memory.PersistentMemoryConfigResult.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.PersistentMemoryConfigResult.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.PersistentMemoryConfigResult.Relationship: description: A relationship to the 'memory.PersistentMemoryConfigResult' resource, or the expanded 'memory.PersistentMemoryConfigResult' resource, or the 'null' value. x-one-of-name: memory.PersistentMemoryConfigResult.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.PersistentMemoryConfigResult' memory.PersistentMemoryConfigResult: title: Memory:Persistent Memory Config Result description: |- Result of a previously applied Persistent Memory configuration on a server. x-allOf-name: memory.PersistentMemoryConfigResult allOf: - # This 'memory.PersistentMemoryConfigResult' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'memory.PersistentMemoryConfigResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryConfigResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryConfigResult' ObjectType: enum: - 'memory.PersistentMemoryConfigResult' ConfigErrorDesc: description: |- Error in the result of a previously applied Persistent Memory configuration on a server. type: string readOnly: true x-omitempty: true ConfigResult: description: |- Result of a previously applied Persistent Memory configuration on a server. type: string readOnly: true x-omitempty: true ConfigSequenceNo: description: |- Sequence number of a previously applied Persistent Memory configuration on a server. type: integer format: int64 readOnly: true x-omitempty: true ConfigState: description: |- State of a previously applied Persistent Memory configuration on a server. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryPersistentMemoryConfiguration: # A Relationship to MO memory.PersistentMemoryConfiguration $ref: '#/components/schemas/memory.PersistentMemoryConfiguration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryPersistentMemoryConfiguration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PersistentMemoryNamespaceConfigResults: # A Relationship to MO memory.PersistentMemoryNamespaceConfigResult description: An array of relationships to memoryPersistentMemoryNamespaceConfigResult resources. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true memory.PersistentMemoryConfigResult.List: title: List of 'memory.PersistentMemoryConfigResult' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.PersistentMemoryConfigResult' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.PersistentMemoryConfigResult' resources matching the request. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryConfigResult' nullable: true memory.PersistentMemoryConfiguration.Response: description: |- The response body of a HTTP GET request for the 'memory.PersistentMemoryConfiguration' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.PersistentMemoryConfiguration' resources. x-one-of-name: memory.PersistentMemoryConfiguration.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.PersistentMemoryConfiguration.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.PersistentMemoryConfiguration.Relationship: description: A relationship to the 'memory.PersistentMemoryConfiguration' resource, or the expanded 'memory.PersistentMemoryConfiguration' resource, or the 'null' value. x-one-of-name: memory.PersistentMemoryConfiguration.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.PersistentMemoryConfiguration' memory.PersistentMemoryConfiguration: title: Memory:Persistent Memory Configuration description: |- Persistent Memory configuration on all the Persistent Memory Modules on a server. x-allOf-name: memory.PersistentMemoryConfiguration allOf: - # This 'memory.PersistentMemoryConfiguration' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'memory.PersistentMemoryConfiguration' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryConfiguration', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryConfiguration' ObjectType: enum: - 'memory.PersistentMemoryConfiguration' MemoryCapacity: description: |- Memory capacity in GiB of a Persistent Memory configuration on a server. type: string readOnly: true x-omitempty: true NumOfModules: description: |- Number of Persistent Memory Modules on a server. type: string readOnly: true x-omitempty: true NumOfRegions: description: |- Number of Persistent Memory Regions on a server. type: string readOnly: true x-omitempty: true PersistentMemoryCapacity: description: |- Persistent memory capacity in GiB of a Persistent Memory configuration on a server. type: string readOnly: true x-omitempty: true ReservedCapacity: description: |- Reserved capacity in GiB of a Persistent Memory configuration on a server. type: string readOnly: true x-omitempty: true SecurityState: description: |- Collective security state of all Persistent Memory modules on a server. type: string readOnly: true x-omitempty: true TotalCapacity: description: |- Total capacity in GiB of a Persistent Memory configuration on a server. type: string readOnly: true x-omitempty: true ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PersistentMemoryConfigResult: # A Relationship to MO memory.PersistentMemoryConfigResult $ref: '#/components/schemas/memory.PersistentMemoryConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryPersistentMemoryConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PersistentMemoryRegions: # A Relationship to MO memory.PersistentMemoryRegion description: An array of relationships to memoryPersistentMemoryRegion resources. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryRegion.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true memory.PersistentMemoryConfiguration.List: title: List of 'memory.PersistentMemoryConfiguration' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.PersistentMemoryConfiguration' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.PersistentMemoryConfiguration' resources matching the request. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryConfiguration' nullable: true memory.PersistentMemoryGoal: title: Persistent Memory Goal description: |- A Persistent Memory Goal that needs to be applied on the associated servers through the policy. This would result in the creation of regions and allocation of volatile memory on the server. x-allOf-name: memory.PersistentMemoryGoal allOf: - # This 'memory.PersistentMemoryGoal' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'memory.PersistentMemoryGoal' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryGoal', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryGoal' ObjectType: enum: - 'memory.PersistentMemoryGoal' MemoryModePercentage: description: |- Volatile memory percentage. type: integer minimum: 0 maximum: 100 x-omitempty: true PersistentMemoryType: description: |- Type of the Persistent Memory configuration where the Persistent Memory Modules are combined in an interleaved set or not. * `app-direct` - The App Direct interleaved Persistent Memory type. * `app-direct-non-interleaved` - The App Direct non-interleaved Persistent Memory type. type: string enum: - 'app-direct' - 'app-direct-non-interleaved' default: app-direct x-omitempty: true SocketId: description: |- CPU Socket ID to which this goal will be applied. * `All Sockets` - All the CPU socket IDs in a server. type: string enum: - 'All Sockets' default: All Sockets x-createOnly: true x-omitempty: true memory.PersistentMemoryLocalSecurity: title: Persistent Memory Local Security description: |- Persistent Memory Local Security specification to be applied to the associated servers through this policy. x-allOf-name: memory.PersistentMemoryLocalSecurity allOf: - # This 'memory.PersistentMemoryLocalSecurity' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'memory.PersistentMemoryLocalSecurity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryLocalSecurity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryLocalSecurity' ObjectType: enum: - 'memory.PersistentMemoryLocalSecurity' Enabled: description: |- Persistent Memory Security state. type: boolean x-omitempty: true IsSecurePassphraseSet: description: |- Indicates whether the value of the 'securePassphrase' property has been set. type: boolean readOnly: true x-omitempty: true SecurePassphrase: description: |- Secure passphrase to be applied on the Persistent Memory Modules on the server. The allowed characters are a-z, A to Z, 0-9, and special characters =, \u0021, &, \#, $, %, +, ^, @, _, *, -. type: string pattern: "^$|^[a-zA-Z0-9=!&#$%+^@_*-]+$" minLength: 8 maxLength: 32 writeOnly: true x-omitempty: true memory.PersistentMemoryLogicalNamespace: title: Persistent Memory Logical Namespace description: |- Persistent Memory Namespace specification that needs to be applied to the associated servers through this policy. This would result in the creation, modification, or deletion of a Namespace on the servers. x-allOf-name: memory.PersistentMemoryLogicalNamespace allOf: - # This 'memory.PersistentMemoryLogicalNamespace' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'memory.PersistentMemoryLogicalNamespace' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryLogicalNamespace', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryLogicalNamespace' ObjectType: enum: - 'memory.PersistentMemoryLogicalNamespace' Capacity: description: |- Capacity of this Namespace that is created or modified. type: integer minimum: 1 maximum: 9223372036854775807 x-omitempty: true Mode: description: |- Mode of this Namespace that is created or modified. * `raw` - The raw mode of Persistent Memory Namespace. * `block` - The block mode of Persistent Memory Namespace. type: string enum: - 'raw' - 'block' default: raw x-omitempty: true Name: description: |- Name of this Namespace to be created on the server. type: string pattern: "^[a-zA-Z0-9#_-][a-zA-Z0-9#_ -]*$" minLength: 1 maxLength: 63 x-createOnly: true x-omitempty: true SocketId: description: |- Socket ID of the region on which this Namespace has to be created or modified. * `1` - The first CPU socket in a server. * `2` - The second CPU socket in a server. * `3` - The third CPU socket in a server. * `4` - The fourth CPU socket in a server. type: integer enum: - 1 - 2 - 3 - 4 default: 1 x-omitempty: true SocketMemoryId: description: |- Socket Memory ID of the region on which this Namespace has to be created or modified. * `Not Applicable` - The socket memory ID is not applicable if app-direct persistent memory type is selected in the goal. * `2` - The second socket memory ID within a socket in a server. * `4` - The fourth socket memory ID within a socket in a server. * `6` - The sixth socket memory ID within a socket in a server. * `8` - The eighth socket memory ID within a socket in a server. * `10` - The tenth socket memory ID within a socket in a server. * `12` - The twelfth socket memory ID within a socket in a server. type: string enum: - 'Not Applicable' - '2' - '4' - '6' - '8' - '10' - '12' default: Not Applicable x-omitempty: true memory.PersistentMemoryNamespace.Response: description: |- The response body of a HTTP GET request for the 'memory.PersistentMemoryNamespace' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.PersistentMemoryNamespace' resources. x-one-of-name: memory.PersistentMemoryNamespace.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.PersistentMemoryNamespace.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.PersistentMemoryNamespace.Relationship: description: A relationship to the 'memory.PersistentMemoryNamespace' resource, or the expanded 'memory.PersistentMemoryNamespace' resource, or the 'null' value. x-one-of-name: memory.PersistentMemoryNamespace.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.PersistentMemoryNamespace' memory.PersistentMemoryNamespace: title: Memory:Persistent Memory Namespace description: |- Persistent Memory Namespace configured within a Persistent Memory Region on a server. x-allOf-name: memory.PersistentMemoryNamespace allOf: - # This 'memory.PersistentMemoryNamespace' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'memory.PersistentMemoryNamespace' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryNamespace', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryNamespace' ObjectType: enum: - 'memory.PersistentMemoryNamespace' Capacity: description: |- Capacity in GiB of the Persistent Memory Namespace. type: string readOnly: true x-omitempty: true HealthState: description: |- Health state of the Persistent Memory Namespace. type: string readOnly: true x-omitempty: true LabelVersion: description: |- Label version of the Persistent Memory Namespace. type: string readOnly: true x-omitempty: true Mode: description: |- Mode of the Persistent Memory Namespace. type: string readOnly: true x-omitempty: true Name: description: |- Name of the Persistent Memory Namespace. type: string readOnly: true x-omitempty: true Uuid: description: |- UUID of the Persistent Memory Namespace. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryPersistentMemoryRegion: # A Relationship to MO memory.PersistentMemoryRegion $ref: '#/components/schemas/memory.PersistentMemoryRegion.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryPersistentMemoryRegion resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true memory.PersistentMemoryNamespace.List: title: List of 'memory.PersistentMemoryNamespace' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.PersistentMemoryNamespace' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.PersistentMemoryNamespace' resources matching the request. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryNamespace' nullable: true memory.PersistentMemoryNamespaceConfigResult.Response: description: |- The response body of a HTTP GET request for the 'memory.PersistentMemoryNamespaceConfigResult' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.PersistentMemoryNamespaceConfigResult' resources. x-one-of-name: memory.PersistentMemoryNamespaceConfigResult.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.PersistentMemoryNamespaceConfigResult.Relationship: description: A relationship to the 'memory.PersistentMemoryNamespaceConfigResult' resource, or the expanded 'memory.PersistentMemoryNamespaceConfigResult' resource, or the 'null' value. x-one-of-name: memory.PersistentMemoryNamespaceConfigResult.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult' memory.PersistentMemoryNamespaceConfigResult: title: Memory:Persistent Memory Namespace Config Result description: |- Result of a previously configured Persistent Memory Namespace on a server. x-allOf-name: memory.PersistentMemoryNamespaceConfigResult allOf: - # This 'memory.PersistentMemoryNamespaceConfigResult' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'memory.PersistentMemoryNamespaceConfigResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryNamespaceConfigResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryNamespaceConfigResult' ObjectType: enum: - 'memory.PersistentMemoryNamespaceConfigResult' ConfigStatus: description: |- Status of the Persistent Memory Namespace needed to be configured. type: string readOnly: true x-omitempty: true Name: description: |- Name of a Persistent Memory Namespace that needed to be configured. type: string readOnly: true x-omitempty: true SocketId: description: |- Socket ID in which the Persistent Memory Namespace needed to be configured. type: string readOnly: true x-omitempty: true SocketMemoryId: description: |- Socket Memory ID in which the Persistent Memory Namespace needed to be configured. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryPersistentMemoryConfigResult: # A Relationship to MO memory.PersistentMemoryConfigResult $ref: '#/components/schemas/memory.PersistentMemoryConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryPersistentMemoryConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true memory.PersistentMemoryNamespaceConfigResult.List: title: List of 'memory.PersistentMemoryNamespaceConfigResult' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.PersistentMemoryNamespaceConfigResult' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.PersistentMemoryNamespaceConfigResult' resources matching the request. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryNamespaceConfigResult' nullable: true memory.PersistentMemoryPolicy.Response: description: |- The response body of a HTTP GET request for the 'memory.PersistentMemoryPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.PersistentMemoryPolicy' resources. x-one-of-name: memory.PersistentMemoryPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.PersistentMemoryPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.PersistentMemoryPolicy: title: Persistent Memory description: |- The Persistent Memory policy defines the reusable Persistent Memory related configuration that can be applied on many servers. This policy allows the application of Persistent Memory Goals and creation of Persistent Memory Regions and Namespaces. The encryption of the Persistent Memory Modules can be enabled through this policy by providing a passphrase. x-allOf-name: memory.PersistentMemoryPolicy allOf: - # This 'memory.PersistentMemoryPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'memory.PersistentMemoryPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryPolicy' ObjectType: enum: - 'memory.PersistentMemoryPolicy' Goals: type: array items: description: |- The list of Persistent Memory Goals that need to be created through this policy. $ref: '#/components/schemas/memory.PersistentMemoryGoal' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true LocalSecurity: description: |- Local security for the Persistent Memory Modules on the server. $ref: '#/components/schemas/memory.PersistentMemoryLocalSecurity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true LogicalNamespaces: type: array items: description: |- The list of Persistent Memory Namespace spec that need to be created through this policy. $ref: '#/components/schemas/memory.PersistentMemoryLogicalNamespace' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ManagementMode: description: |- Management Mode of the policy. This can be either Configured from Intersight or Configured from Operating System. * `configured-from-intersight` - The Persistent Memory Modules are configured from Intersight thorugh Persistent Memory policy. * `configured-from-operating-system` - The Persistent Memory Modules are configured from operating system thorugh OS tools. type: string enum: - 'configured-from-intersight' - 'configured-from-operating-system' default: configured-from-intersight x-omitempty: true RetainNamespaces: description: |- Persistent Memory Namespaces to be retained or not. type: boolean x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true memory.PersistentMemoryPolicy.List: title: List of 'memory.PersistentMemoryPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.PersistentMemoryPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.PersistentMemoryPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryPolicy' nullable: true memory.PersistentMemoryRegion.Response: description: |- The response body of a HTTP GET request for the 'memory.PersistentMemoryRegion' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.PersistentMemoryRegion' resources. x-one-of-name: memory.PersistentMemoryRegion.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.PersistentMemoryRegion.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.PersistentMemoryRegion.Relationship: description: A relationship to the 'memory.PersistentMemoryRegion' resource, or the expanded 'memory.PersistentMemoryRegion' resource, or the 'null' value. x-one-of-name: memory.PersistentMemoryRegion.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.PersistentMemoryRegion' memory.PersistentMemoryRegion: title: Memory:Persistent Memory Region description: |- Persistent Memory Region configured on the Persistent Memory Modules on a server. x-allOf-name: memory.PersistentMemoryRegion allOf: - # This 'memory.PersistentMemoryRegion' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'memory.PersistentMemoryRegion' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryRegion', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryRegion' ObjectType: enum: - 'memory.PersistentMemoryRegion' FreeCapacity: description: |- Free capacity in GiB of the Persistent Memory Region. type: string readOnly: true x-omitempty: true HealthState: description: |- Health state of the Persistent Memory Region. type: string readOnly: true x-omitempty: true InterleavedSetId: description: |- ID of the Interleaved Set formed for this Persistent Memory Region. type: string readOnly: true x-omitempty: true LocaterIds: description: |- Set of locator IDs that are included in the Persistent Memory Region. type: string readOnly: true x-omitempty: true PersistentMemoryType: description: |- Persistent Memory type of the Persistent Memory Region. type: string readOnly: true x-omitempty: true RegionId: description: |- ID of the Persistent Memory Region. type: string readOnly: true x-omitempty: true SocketId: description: |- Socket ID of the Persistent Memory Region. type: string readOnly: true x-omitempty: true SocketMemoryId: description: |- Socket Memory ID of the Persistent Memory Region. type: string readOnly: true x-omitempty: true TotalCapacity: description: |- Total capacity in GiB of the Persistent Memory Region. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryPersistentMemoryConfiguration: # A Relationship to MO memory.PersistentMemoryConfiguration $ref: '#/components/schemas/memory.PersistentMemoryConfiguration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryPersistentMemoryConfiguration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PersistentMemoryNamespaces: # A Relationship to MO memory.PersistentMemoryNamespace description: An array of relationships to memoryPersistentMemoryNamespace resources. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryNamespace.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true memory.PersistentMemoryRegion.List: title: List of 'memory.PersistentMemoryRegion' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.PersistentMemoryRegion' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.PersistentMemoryRegion' resources matching the request. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryRegion' nullable: true memory.PersistentMemoryUnit.Response: description: |- The response body of a HTTP GET request for the 'memory.PersistentMemoryUnit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.PersistentMemoryUnit' resources. x-one-of-name: memory.PersistentMemoryUnit.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.PersistentMemoryUnit.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.PersistentMemoryUnit.Relationship: description: A relationship to the 'memory.PersistentMemoryUnit' resource, or the expanded 'memory.PersistentMemoryUnit' resource, or the 'null' value. x-one-of-name: memory.PersistentMemoryUnit.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.PersistentMemoryUnit' memory.PersistentMemoryUnit: title: Memory:Persistent Memory Unit description: |- Persistent Memory Module on a server. x-allOf-name: memory.PersistentMemoryUnit allOf: - # This 'memory.PersistentMemoryUnit' class inherits all properties from its parent class memory.AbstractUnit. $ref: '#/components/schemas/memory.AbstractUnit' - # The definition of all the properties specified in this 'memory.PersistentMemoryUnit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.PersistentMemoryUnit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.PersistentMemoryUnit' ObjectType: enum: - 'memory.PersistentMemoryUnit' AppDirectCapacity: description: |- AppDirect capacity in GiB of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true CountStatus: description: |- Count status of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true FirmwareVersion: description: |- Firmware version of the firware running on the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true FrozenStatus: description: |- Frozen status of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true HealthState: description: |- Health state of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true LockStatus: description: |- Lock status of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true MemoryCapacity: description: |- Memory capacity in GiB of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true MemoryId: description: |- ID of the Persistent Memory Module on a server. type: integer format: int64 readOnly: true x-omitempty: true PersistentMemoryCapacity: description: |- Persistent Memory capacity in GiB of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true ReservedCapacity: description: |- Reserved capacity in GiB of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true SecurityStatus: description: |- Security status of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true SocketId: description: |- Socket ID of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true SocketMemoryId: description: |- Socket Memory ID of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true TotalCapacity: description: |- Total capacity in GiB of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true Uid: description: |- UID of the Persistent Memory Module on a server. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryArray: # A Relationship to MO memory.Array $ref: '#/components/schemas/memory.Array.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true memory.PersistentMemoryUnit.List: title: List of 'memory.PersistentMemoryUnit' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.PersistentMemoryUnit' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.PersistentMemoryUnit' resources matching the request. type: array items: $ref: '#/components/schemas/memory.PersistentMemoryUnit' nullable: true memory.Unit.Response: description: |- The response body of a HTTP GET request for the 'memory.Unit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'memory.Unit' resources. x-one-of-name: memory.Unit.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/memory.Unit.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType memory.Unit.Relationship: description: A relationship to the 'memory.Unit' resource, or the expanded 'memory.Unit' resource, or the 'null' value. x-one-of-name: memory.Unit.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/memory.Unit' memory.Unit: title: Memory:Unit description: |- This represents a memory DIMM on a server. x-allOf-name: memory.Unit allOf: - # This 'memory.Unit' class inherits all properties from its parent class memory.AbstractUnit. $ref: '#/components/schemas/memory.AbstractUnit' - # The definition of all the properties specified in this 'memory.Unit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'memory.Unit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'memory.Unit' ObjectType: enum: - 'memory.Unit' MemoryId: description: |- This represents the ID of a regular DIMM on a server. type: integer format: int64 readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true MemoryArray: # A Relationship to MO memory.Array $ref: '#/components/schemas/memory.Array.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a memoryArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true memory.Unit.List: title: List of 'memory.Unit' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'memory.Unit' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'memory.Unit' resources matching the request. type: array items: $ref: '#/components/schemas/memory.Unit' nullable: true meta.AccessPrivilege: title: Meta:Access Privilege description: |- The required access privilege for a given Managed Object and CRUD operation. x-allOf-name: meta.AccessPrivilege allOf: - # This 'meta.AccessPrivilege' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'meta.AccessPrivilege' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'meta.AccessPrivilege', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'meta.AccessPrivilege' ObjectType: enum: - 'meta.AccessPrivilege' Method: description: |- The type of CRUD operation (create, read, update, delete) for which an access privilege is required. * `Update` - The 'update' operation/state. * `Create` - The 'create' operation/state. * `Read` - The 'read' operation/state. * `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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'meta.Definition' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'meta.Definition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'meta.Definition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'meta.Definition' ObjectType: enum: - 'meta.Definition' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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 DisplayNameMetas: type: array items: description: |- The user appropriate display name meta. $ref: '#/components/schemas/meta.DisplayNameDefinition' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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. * `ManagedObject` - The meta.Definition object describes a managed object. * `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 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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=yes. 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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. The '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 allOf: - # This 'meta.DisplayNameDefinition' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'meta.DisplayNameDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'meta.DisplayNameDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'meta.DisplayNameDefinition' ObjectType: enum: - 'meta.DisplayNameDefinition' 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.PropDefinition: title: Meta:Prop Definition description: |- Definitions for the properties in a meta. x-allOf-name: meta.PropDefinition allOf: - # This 'meta.PropDefinition' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'meta.PropDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'meta.PropDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'meta.PropDefinition' ObjectType: enum: - 'meta.PropDefinition' ApiAccess: description: |- API access control for the property. Examples are NoAccess, ReadOnly, CreateOnly etc. * `NoAccess` - The property is not accessible from the API. * `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. * `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. * `ReadWrite` - The property has read/write access. * `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. * `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 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. For example, Encrypted or Cleartext. * `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. * `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. * `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. * `Bcrypt` - The value of the property is hashed using the bcrypt key derivation function. * `Sha512crypt` - The value of the property is hashed using the sha512crypt key derivation function. * `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 meta.RelationshipDefinition: title: Meta:Relationship Definition description: |- Definitions for the relationship in a meta. x-allOf-name: meta.RelationshipDefinition allOf: - # This 'meta.RelationshipDefinition' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'meta.RelationshipDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'meta.RelationshipDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'meta.RelationshipDefinition' ObjectType: enum: - 'meta.RelationshipDefinition' ApiAccess: description: |- API access definition for this relationship. * `NoAccess` - The property is not accessible from the API. * `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. * `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. * `ReadWrite` - The property has read/write access. * `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. * `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 Type: description: |- Fully qualified type of the foreign managed object. type: string readOnly: true x-omitempty: true mo.BaseComplexType: type: object # The discriminator refers to the property that specifies the data type name. # https://swagger.io/specification/#discriminatorObject # All MO sub-classes and complex sub-types use the same "ClassId" discriminator. 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 properties: ClassId: description: |- The concrete type of this complex type. Its value must be the same as the 'objectType' property. The OpenAPI document references this property as a discriminator value. type: string readOnly: true x-omitempty: true ObjectType: description: "The concrete type of this complex type.\nThe ObjectType property must be set explicitly by API clients when the type is ambiguous. In all other cases, the \nObjectType is optional. \nThe type is ambiguous when a managed object contains an array of nested documents, and the documents in the array\nare heterogeneous, i.e. the array can contain nested documents of different types." type: string x-omitempty: 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' mo.BaseMo: type: object # The discriminator refers to the property that specifies the data type name. # https://swagger.io/specification/#discriminatorObject # All MO sub-classes and complex sub-types use the same "ClassId" discriminator. discriminator: propertyName: ClassId title: Mo:Base Mo description: |- The base abstract class for all Cisco Intersight managed objects. required: - ClassId - ObjectType properties: AccountMoid: description: |- The Account ID for this managed object. type: string readOnly: true x-omitempty: true ClassId: description: |- The concrete type of this complex type. Its value must be the same as the 'objectType' property. The OpenAPI document references this property as a discriminator value. 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 ObjectType: description: |- The fully-qualified type of this managed object, i.e. the class name. This property is optional. The ObjectType is implied from the URL path. If specified, the value of objectType must match the class name specified in the URL path. type: string readOnly: 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 SharedScope: description: |- Intersight provides pre-built workflows, tasks and policies to end users through global catalogs. Objects 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true VersionContext: description: |- The versioning info for this managed object. $ref: '#/components/schemas/mo.VersionContext' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Ancestors: # A Relationship to MO mo.BaseMo description: An array of relationships to moBaseMo resources. type: array items: $ref: '#/components/schemas/mo.BaseMo.Relationship' nullable: true readOnly: true Parent: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PermissionResources: # A Relationship to MO mo.BaseMo 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. x-allOf-name: mo.MoRef allOf: - # This 'mo.MoRef' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'mo.MoRef' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'mo.MoRef', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'mo.MoRef' 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 be set instead of 'moid' by clients. 1. If 'moid' is set this field is ignored. 1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'. type: string readOnly: true x-omitempty: true link: # See https://github.com/OAI/OpenAPI-Specification/issues/577 for discussion about # HATEOAS links in OpenAPI. 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 assigning meta-data tags to any object. properties: Key: description: |- The string representation of a tag key. type: string minLength: 1 maxLength: 128 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 allOf: - # This 'mo.VersionContext' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'mo.VersionContext' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'mo.VersionContext', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'mo.VersionContext' ObjectType: enum: - 'mo.VersionContext' InterestedMos: type: array items: description: |- A collection of objects that have reference to this versioned object. The lifecycle of the versioned object is based on the interestedMos list; the versioned object will be purged when interestedMos is empty. $ref: '#/components/schemas/mo.MoRef' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true RefMo: description: |- A reference to the original Managed Object. $ref: '#/components/schemas/mo.MoRef' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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" that is used to keep track of snapshots of policies and profiles that are intended to be configured to target endpoints. * `Modified` - Version created every time an object is modified. * `Configured` - Version created every time an object is configured to the service profile. * `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 network.Element.Response: description: |- The response body of a HTTP GET request for the 'network.Element' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'network.Element' resources. x-one-of-name: network.Element.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/network.Element.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType network.Element.Relationship: description: A relationship to the 'network.Element' resource, or the expanded 'network.Element' resource, or the 'null' value. x-one-of-name: network.Element.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/network.Element' network.Element: title: Network:Element description: |- A Unified Computing Systems (UCS) Fabric Interconnect. x-allOf-name: network.Element allOf: - # This 'network.Element' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'network.Element' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'network.Element', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'network.Element' ObjectType: enum: - 'network.Element' AdminEvacState: description: |- Administratively configured state of Fabric Evacuation feature, for this switch. type: string readOnly: true x-omitempty: true AdminInbandInterfaceState: description: |- The administrative state of the network Element inband management interface. type: string readOnly: true x-omitempty: true AlarmSummary: description: |- The summary of alarm counts based on the severity types (Critical or Warning). $ref: '#/components/schemas/compute.AlarmSummary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AvailableMemory: description: |- Available memory (un-used) on this switch platform. type: string readOnly: true x-omitempty: true EthernetMode: description: |- The user configured Ethernet operational mode for this switch (End-Host or Switching). type: string readOnly: true x-omitempty: true FaultSummary: description: |- The fault summary of the network Element out-of-band management interface. deprecated: true type: integer format: int64 x-omitempty: true FcMode: description: |- The user configured FC operational mode for this switch (End-Host or Switching). type: string readOnly: true x-omitempty: true InbandIpAddress: description: |- The IP address of the network Element inband management interface. type: string readOnly: true x-omitempty: true InbandIpGateway: description: |- The default gateway of the network Element inband management interface. type: string readOnly: true x-omitempty: true InbandIpMask: description: |- The network mask of the network Element inband management interface. type: string readOnly: true x-omitempty: true InbandVlan: description: |- The VLAN ID of the network Element inband management interface. type: integer format: int64 readOnly: true x-omitempty: true ManagementMode: description: |- The management mode of the fabric interconnect. * `IntersightStandalone` - Intersight Standalone mode of operation. * `UCSM` - Unified Computing System Manager mode of operation. * `Intersight` - Intersight managed mode of operation. type: string enum: - 'IntersightStandalone' - 'UCSM' - 'Intersight' default: IntersightStandalone x-omitempty: true OperEvacState: description: |- Operational state of the Fabric Evacuation feature, for this switch. type: string readOnly: true x-omitempty: true Operability: description: |- The switch's current overall operational/health state. type: string readOnly: true x-omitempty: true OutOfBandIpAddress: description: |- The IP address of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpGateway: description: |- The default gateway of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpMask: description: |- The network mask of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv4Address: description: |- The IPv4 address of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv4Gateway: description: |- The default IPv4 gateway of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv4Mask: description: |- The network mask of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv6Address: description: |- The IPv6 address of the network Element out-of-band management interface. type: string x-omitempty: true OutOfBandIpv6Gateway: description: |- The default IPv6 gateway of the network Element out-of-band management interface. type: string x-omitempty: true OutOfBandIpv6Prefix: description: |- The network mask of the network Element out-of-band management interface. type: string x-omitempty: true OutOfBandMac: description: |- The MAC address of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true SwitchId: description: |- The Switch Id of the network Element. type: string readOnly: true x-omitempty: true TotalMemory: description: |- Total available memory on this switch platform. type: integer format: int64 readOnly: true x-omitempty: true Cards: # A Relationship to MO equipment.SwitchCard description: An array of relationships to equipmentSwitchCard resources. type: array items: $ref: '#/components/schemas/equipment.SwitchCard.Relationship' nullable: true readOnly: true Fanmodules: # A Relationship to MO equipment.FanModule description: An array of relationships to equipmentFanModule resources. type: array items: $ref: '#/components/schemas/equipment.FanModule.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ManagementContoller: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ManagementEntity: # A Relationship to MO management.Entity $ref: '#/components/schemas/management.Entity.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementEntity resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkFcZoneInfo: # A Relationship to MO network.FcZoneInfo $ref: '#/components/schemas/network.FcZoneInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkFcZoneInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkVlanPortInfo: # A Relationship to MO network.VlanPortInfo $ref: '#/components/schemas/network.VlanPortInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkVlanPortInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortMacBindings: # A Relationship to MO port.MacBinding description: An array of relationships to portMacBinding resources. type: array items: $ref: '#/components/schemas/port.MacBinding.Relationship' nullable: true Psus: # A Relationship to MO equipment.Psu description: An array of relationships to equipmentPsu resources. type: array items: $ref: '#/components/schemas/equipment.Psu.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageItems: # A Relationship to MO storage.Item description: An array of relationships to storageItem resources. type: array items: $ref: '#/components/schemas/storage.Item.Relationship' nullable: true readOnly: true TopSystem: # A Relationship to MO top.System $ref: '#/components/schemas/top.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a topSystem resource. When the $expand query parameter is specified, the referenced resource is returned inline. UcsmRunningFirmware: # A Relationship to MO firmware.RunningFirmware $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareRunningFirmware resource. When the $expand query parameter is specified, the referenced resource is returned inline. network.Element.List: title: List of 'network.Element' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'network.Element' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'network.Element' resources matching the request. type: array items: $ref: '#/components/schemas/network.Element' nullable: true network.ElementSummary.Response: description: |- The response body of a HTTP GET request for the 'network.ElementSummary' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'network.ElementSummary' resources. x-one-of-name: network.ElementSummary.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/network.ElementSummary.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType network.ElementSummary: title: Network:Element Summary description: |- View MO which aggregates information pertaining to a network element from mutiple MOs. x-allOf-name: network.ElementSummary allOf: - # This 'network.ElementSummary' class inherits all properties from its parent class views.View. $ref: '#/components/schemas/views.View' - # The definition of all the properties specified in this 'network.ElementSummary' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'network.ElementSummary', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'network.ElementSummary' ObjectType: enum: - 'network.ElementSummary' AdminEvacState: description: |- Administratively configured state of Fabric Evacuation feature, for this switch. type: string readOnly: true x-omitempty: true AdminInbandInterfaceState: description: |- The administrative state of the network Element inband management interface. type: string readOnly: true x-omitempty: true AlarmSummary: description: |- The summary of alarm counts based on the severity types (Critical or Warning). $ref: '#/components/schemas/compute.AlarmSummary' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true AvailableMemory: description: |- Available memory (un-used) on this switch platform. type: string readOnly: true x-omitempty: true DeviceMoId: description: |- The database identifier of the registered device of an object. type: string readOnly: true x-omitempty: true Dn: description: |- The Distinguished Name unambiguously identifies an object in the system. type: string readOnly: true x-omitempty: true EthernetMode: description: |- The user configured Ethernet operational mode for this switch (End-Host or Switching). type: string readOnly: true x-omitempty: true FaultSummary: description: |- The fault summary of the network Element out-of-band management interface. deprecated: true type: integer format: int64 readOnly: true x-omitempty: true FcMode: description: |- The user configured FC operational mode for this switch (End-Host or Switching). type: string readOnly: true x-omitempty: true Firmware: description: |- Running firmware information. type: string readOnly: true x-omitempty: true InbandIpAddress: description: |- The IP address of the network Element inband management interface. type: string readOnly: true x-omitempty: true InbandIpGateway: description: |- The default gateway of the network Element inband management interface. type: string readOnly: true x-omitempty: true InbandIpMask: description: |- The network mask of the network Element inband management interface. type: string readOnly: true x-omitempty: true InbandVlan: description: |- The VLAN ID of the network Element inband management interface. type: integer format: int64 readOnly: true x-omitempty: true Ipv4Address: description: |- IP version 4 address is saved in this property. type: string readOnly: true x-omitempty: true ManagementMode: description: |- The management mode of the fabric interconnect. * `IntersightStandalone` - Intersight Standalone mode of operation. * `UCSM` - Unified Computing System Manager mode of operation. * `Intersight` - Intersight managed mode of operation. type: string enum: - 'IntersightStandalone' - 'UCSM' - 'Intersight' default: IntersightStandalone readOnly: true x-omitempty: true Model: description: |- This field identifies the model of the given component. type: string readOnly: true x-omitempty: true Name: description: |- Name of the ElementSummary object is saved in this property. type: string readOnly: true x-omitempty: true NumEtherPorts: description: |- Total number of Ethernet ports. type: integer format: int64 readOnly: true x-omitempty: true NumEtherPortsConfigured: description: |- Total number of configured Ethernet ports. type: integer format: int64 readOnly: true x-omitempty: true NumEtherPortsLinkUp: description: |- Total number of Ethernet ports which are UP. type: integer format: int64 readOnly: true x-omitempty: true NumExpansionModules: description: |- Total number of expansion modules. type: integer format: int64 readOnly: true x-omitempty: true NumFcPorts: description: |- Total number of FC ports. type: integer format: int64 readOnly: true x-omitempty: true NumFcPortsConfigured: description: |- Total number of configured FC ports. type: integer format: int64 readOnly: true x-omitempty: true NumFcPortsLinkUp: description: |- Total number of FC ports which are UP. type: integer format: int64 readOnly: true x-omitempty: true OperEvacState: description: |- Operational state of the Fabric Evacuation feature, for this switch. type: string readOnly: true x-omitempty: true Operability: description: |- The switch's current overall operational/health state. type: string readOnly: true x-omitempty: true OutOfBandIpAddress: description: |- The IP address of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpGateway: description: |- The default gateway of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpMask: description: |- The network mask of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv4Address: description: |- The IPv4 address of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv4Gateway: description: |- The default IPv4 gateway of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv4Mask: description: |- The network mask of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv6Address: description: |- The IPv6 address of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv6Gateway: description: |- The default IPv6 gateway of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandIpv6Prefix: description: |- The network mask of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true OutOfBandMac: description: |- The MAC address of the network Element out-of-band management interface. type: string readOnly: true x-omitempty: true Revision: description: |- This field identifies the revision of the given component. type: string readOnly: true x-omitempty: true Rn: description: |- The Relative Name uniquely identifies an object within a given context. type: string readOnly: true x-omitempty: true Serial: description: |- This field identifies the serial of the given component. type: string readOnly: true x-omitempty: true SourceObjectType: description: |- The source object type of this view MO. type: string readOnly: true x-omitempty: true SwitchId: description: |- The Switch Id of the network Element. type: string readOnly: true x-omitempty: true TotalMemory: description: |- Total available memory on this switch platform. type: integer format: int64 readOnly: true x-omitempty: true Vendor: description: |- This field identifies the vendor of the given component. type: string readOnly: true x-omitempty: true Version: description: |- Version holds the firmware version related information. type: string readOnly: true x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true network.ElementSummary.List: title: List of 'network.ElementSummary' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'network.ElementSummary' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'network.ElementSummary' resources matching the request. type: array items: $ref: '#/components/schemas/network.ElementSummary' nullable: true network.FcZoneInfo.Response: description: |- The response body of a HTTP GET request for the 'network.FcZoneInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'network.FcZoneInfo' resources. x-one-of-name: network.FcZoneInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/network.FcZoneInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType network.FcZoneInfo.Relationship: description: A relationship to the 'network.FcZoneInfo' resource, or the expanded 'network.FcZoneInfo' resource, or the 'null' value. x-one-of-name: network.FcZoneInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/network.FcZoneInfo' network.FcZoneInfo: title: Network:Fc Zone Info description: |- FC Zone information of a Fabric Interconnect. x-allOf-name: network.FcZoneInfo allOf: - # This 'network.FcZoneInfo' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'network.FcZoneInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'network.FcZoneInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'network.FcZoneInfo' ObjectType: enum: - 'network.FcZoneInfo' UserZoneCount: description: |- The number of Fibre Channel user zones defined on a Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true UserZoneLimit: description: |- The maximum number of Fibre Channel user zones allowed on a Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true ZoneCount: description: |- The number of Fibre Channel zones defined on a Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true ZoneLimit: description: |- The maximum number of Fibre Channel zones allowed on a Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true network.FcZoneInfo.List: title: List of 'network.FcZoneInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'network.FcZoneInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'network.FcZoneInfo' resources matching the request. type: array items: $ref: '#/components/schemas/network.FcZoneInfo' nullable: true network.VlanPortInfo.Response: description: |- The response body of a HTTP GET request for the 'network.VlanPortInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'network.VlanPortInfo' resources. x-one-of-name: network.VlanPortInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/network.VlanPortInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType network.VlanPortInfo.Relationship: description: A relationship to the 'network.VlanPortInfo' resource, or the expanded 'network.VlanPortInfo' resource, or the 'null' value. x-one-of-name: network.VlanPortInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/network.VlanPortInfo' network.VlanPortInfo: title: Network:Vlan Port Info description: |- Vlan Port information of a Fabric Interconnect. x-allOf-name: network.VlanPortInfo allOf: - # This 'network.VlanPortInfo' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'network.VlanPortInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'network.VlanPortInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'network.VlanPortInfo' ObjectType: enum: - 'network.VlanPortInfo' AccessVlanPortCount: description: |- The number of available VLAN access ports on a Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true BorderVlanPortCount: description: |- The number of available VLAN border ports on a Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true CompressedVlanPortCount: description: |- The number of compressed VLAN ports on a Fabric Interconnect. type: string readOnly: true x-omitempty: true UncompressedVlanPortCount: description: |- The number of uncompressed VLAN ports on a Fabric Interconnect. type: string readOnly: true x-omitempty: true VlanPortLimit: description: |- The maximum number of VLAN ports allowed on a Fabric Interconnect. type: integer format: int64 readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true network.VlanPortInfo.List: title: List of 'network.VlanPortInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'network.VlanPortInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'network.VlanPortInfo' resources matching the request. type: array items: $ref: '#/components/schemas/network.VlanPortInfo' nullable: true networkconfig.Policy.Response: description: |- The response body of a HTTP GET request for the 'networkconfig.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'networkconfig.Policy' resources. x-one-of-name: networkconfig.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/networkconfig.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType networkconfig.Policy: title: Network Connectivity description: |- Enable or disable Dynamic DNS, add or update DNS settings for IPv4 and IPv6 on Cisco IMC. x-allOf-name: networkconfig.Policy allOf: - # This 'networkconfig.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'networkconfig.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'networkconfig.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'networkconfig.Policy' ObjectType: enum: - 'networkconfig.Policy' AlternateIpv4dnsServer: description: |- IP address of the secondary DNS server. type: string x-omitempty: true AlternateIpv6dnsServer: description: |- IP address of the secondary DNS server. type: string x-omitempty: true DynamicDnsDomain: description: |- The domain name appended to a hostname for a Dynamic DNS (DDNS) update. If left blank, only a hostname is sent to the DDNS update request. type: string pattern: "^$|^[a-zA-Z0-9]+([-.]{1}[a-zA-Z0-9]+)*$" minLength: 0 maxLength: 255 x-omitempty: true EnableDynamicDns: description: |- If enabled, updates the resource records to the DNS from Cisco IMC. type: boolean x-omitempty: true EnableIpv4dnsFromDhcp: description: |- If enabled, Cisco IMC retrieves the DNS server addresses from DHCP. Use DHCP field must be enabled for IPv4 in Cisco IMC to enable it. type: boolean x-omitempty: true EnableIpv6: description: |- If enabled, allows to configure IPv6 properties. type: boolean x-omitempty: true EnableIpv6dnsFromDhcp: description: |- If enabled, Cisco IMC retrieves the DNS server addresses from DHCP. Use DHCP field must be enabled for IPv6 in Cisco IMC to enable it. type: boolean x-omitempty: true PreferredIpv4dnsServer: description: |- IP address of the primary DNS server. type: string x-omitempty: true PreferredIpv6dnsServer: description: |- IP address of the primary DNS server. type: string x-omitempty: true ApplianceAccount: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true networkconfig.Policy.List: title: List of 'networkconfig.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'networkconfig.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'networkconfig.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/networkconfig.Policy' nullable: true niaapi.ApicCcoPost.Response: description: |- The response body of a HTTP GET request for the 'niaapi.ApicCcoPost' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.ApicCcoPost' resources. x-one-of-name: niaapi.ApicCcoPost.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.ApicCcoPost.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.ApicCcoPost: title: Niaapi:Apic Cco Post description: |- The post reporting a new release is available for APIC. x-allOf-name: niaapi.ApicCcoPost allOf: - # This 'niaapi.ApicCcoPost' class inherits all properties from its parent class niaapi.NewReleasePost. $ref: '#/components/schemas/niaapi.NewReleasePost' niaapi.ApicCcoPost.List: title: List of 'niaapi.ApicCcoPost' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.ApicCcoPost' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.ApicCcoPost' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.ApicCcoPost' nullable: true niaapi.ApicFieldNotice.Response: description: |- The response body of a HTTP GET request for the 'niaapi.ApicFieldNotice' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.ApicFieldNotice' resources. x-one-of-name: niaapi.ApicFieldNotice.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.ApicFieldNotice.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.ApicFieldNotice: title: Niaapi:Apic Field Notice description: |- The field notice reporting bug and related software or hardware for APIC. x-allOf-name: niaapi.ApicFieldNotice allOf: - # This 'niaapi.ApicFieldNotice' class inherits all properties from its parent class niaapi.FieldNotice. $ref: '#/components/schemas/niaapi.FieldNotice' niaapi.ApicFieldNotice.List: title: List of 'niaapi.ApicFieldNotice' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.ApicFieldNotice' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.ApicFieldNotice' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.ApicFieldNotice' nullable: true niaapi.ApicHweol.Response: description: |- The response body of a HTTP GET request for the 'niaapi.ApicHweol' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.ApicHweol' resources. x-one-of-name: niaapi.ApicHweol.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.ApicHweol.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.ApicHweol: title: Niaapi:Apic Hweol description: |- The hardware end of life notice for APIC. x-allOf-name: niaapi.ApicHweol allOf: - # This 'niaapi.ApicHweol' class inherits all properties from its parent class niaapi.HardwareEol. $ref: '#/components/schemas/niaapi.HardwareEol' niaapi.ApicHweol.List: title: List of 'niaapi.ApicHweol' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.ApicHweol' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.ApicHweol' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.ApicHweol' nullable: true niaapi.ApicLatestMaintainedRelease.Response: description: |- The response body of a HTTP GET request for the 'niaapi.ApicLatestMaintainedRelease' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.ApicLatestMaintainedRelease' resources. x-one-of-name: niaapi.ApicLatestMaintainedRelease.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.ApicLatestMaintainedRelease.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.ApicLatestMaintainedRelease: title: Niaapi:Apic Latest Maintained Release description: |- This contains the latest maintained release information for each release on APIC. x-allOf-name: niaapi.ApicLatestMaintainedRelease allOf: - # This 'niaapi.ApicLatestMaintainedRelease' class inherits all properties from its parent class niaapi.MaintainedRelease. $ref: '#/components/schemas/niaapi.MaintainedRelease' niaapi.ApicLatestMaintainedRelease.List: title: List of 'niaapi.ApicLatestMaintainedRelease' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.ApicLatestMaintainedRelease' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.ApicLatestMaintainedRelease' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.ApicLatestMaintainedRelease' nullable: true niaapi.ApicReleaseRecommend.Response: description: |- The response body of a HTTP GET request for the 'niaapi.ApicReleaseRecommend' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.ApicReleaseRecommend' resources. x-one-of-name: niaapi.ApicReleaseRecommend.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.ApicReleaseRecommend.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.ApicReleaseRecommend: title: Niaapi:Apic Release Recommend description: |- The recommend version information for each release on APIC. x-allOf-name: niaapi.ApicReleaseRecommend allOf: - # This 'niaapi.ApicReleaseRecommend' class inherits all properties from its parent class niaapi.ReleaseRecommend. $ref: '#/components/schemas/niaapi.ReleaseRecommend' niaapi.ApicReleaseRecommend.List: title: List of 'niaapi.ApicReleaseRecommend' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.ApicReleaseRecommend' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.ApicReleaseRecommend' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.ApicReleaseRecommend' nullable: true niaapi.ApicSweol.Response: description: |- The response body of a HTTP GET request for the 'niaapi.ApicSweol' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.ApicSweol' resources. x-one-of-name: niaapi.ApicSweol.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.ApicSweol.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.ApicSweol: title: Niaapi:Apic Sweol description: |- The software end of life notice for APIC. x-allOf-name: niaapi.ApicSweol allOf: - # This 'niaapi.ApicSweol' class inherits all properties from its parent class niaapi.SoftwareEol. $ref: '#/components/schemas/niaapi.SoftwareEol' niaapi.ApicSweol.List: title: List of 'niaapi.ApicSweol' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.ApicSweol' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.ApicSweol' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.ApicSweol' nullable: true niaapi.DcnmCcoPost.Response: description: |- The response body of a HTTP GET request for the 'niaapi.DcnmCcoPost' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.DcnmCcoPost' resources. x-one-of-name: niaapi.DcnmCcoPost.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.DcnmCcoPost.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.DcnmCcoPost: title: Niaapi:Dcnm Cco Post description: |- The post reporting a new release is available for DCNM. x-allOf-name: niaapi.DcnmCcoPost allOf: - # This 'niaapi.DcnmCcoPost' class inherits all properties from its parent class niaapi.NewReleasePost. $ref: '#/components/schemas/niaapi.NewReleasePost' niaapi.DcnmCcoPost.List: title: List of 'niaapi.DcnmCcoPost' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.DcnmCcoPost' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.DcnmCcoPost' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.DcnmCcoPost' nullable: true niaapi.DcnmFieldNotice.Response: description: |- The response body of a HTTP GET request for the 'niaapi.DcnmFieldNotice' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.DcnmFieldNotice' resources. x-one-of-name: niaapi.DcnmFieldNotice.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.DcnmFieldNotice.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.DcnmFieldNotice: title: Niaapi:Dcnm Field Notice description: |- The field notice reporting bug and related software or hardware for DCNM. x-allOf-name: niaapi.DcnmFieldNotice allOf: - # This 'niaapi.DcnmFieldNotice' class inherits all properties from its parent class niaapi.FieldNotice. $ref: '#/components/schemas/niaapi.FieldNotice' niaapi.DcnmFieldNotice.List: title: List of 'niaapi.DcnmFieldNotice' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.DcnmFieldNotice' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.DcnmFieldNotice' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.DcnmFieldNotice' nullable: true niaapi.DcnmHweol.Response: description: |- The response body of a HTTP GET request for the 'niaapi.DcnmHweol' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.DcnmHweol' resources. x-one-of-name: niaapi.DcnmHweol.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.DcnmHweol.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.DcnmHweol: title: Niaapi:Dcnm Hweol description: |- The hardware end of life notice for DCNM. x-allOf-name: niaapi.DcnmHweol allOf: - # This 'niaapi.DcnmHweol' class inherits all properties from its parent class niaapi.HardwareEol. $ref: '#/components/schemas/niaapi.HardwareEol' niaapi.DcnmHweol.List: title: List of 'niaapi.DcnmHweol' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.DcnmHweol' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.DcnmHweol' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.DcnmHweol' nullable: true niaapi.DcnmLatestMaintainedRelease.Response: description: |- The response body of a HTTP GET request for the 'niaapi.DcnmLatestMaintainedRelease' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.DcnmLatestMaintainedRelease' resources. x-one-of-name: niaapi.DcnmLatestMaintainedRelease.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.DcnmLatestMaintainedRelease.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.DcnmLatestMaintainedRelease: title: Niaapi:Dcnm Latest Maintained Release description: |- This contains the latest maintained release information for each release on DCNM. x-allOf-name: niaapi.DcnmLatestMaintainedRelease allOf: - # This 'niaapi.DcnmLatestMaintainedRelease' class inherits all properties from its parent class niaapi.MaintainedRelease. $ref: '#/components/schemas/niaapi.MaintainedRelease' niaapi.DcnmLatestMaintainedRelease.List: title: List of 'niaapi.DcnmLatestMaintainedRelease' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.DcnmLatestMaintainedRelease' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.DcnmLatestMaintainedRelease' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.DcnmLatestMaintainedRelease' nullable: true niaapi.DcnmReleaseRecommend.Response: description: |- The response body of a HTTP GET request for the 'niaapi.DcnmReleaseRecommend' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.DcnmReleaseRecommend' resources. x-one-of-name: niaapi.DcnmReleaseRecommend.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.DcnmReleaseRecommend.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.DcnmReleaseRecommend: title: Niaapi:Dcnm Release Recommend description: |- The recommend version information for each release on DCNM. x-allOf-name: niaapi.DcnmReleaseRecommend allOf: - # This 'niaapi.DcnmReleaseRecommend' class inherits all properties from its parent class niaapi.ReleaseRecommend. $ref: '#/components/schemas/niaapi.ReleaseRecommend' niaapi.DcnmReleaseRecommend.List: title: List of 'niaapi.DcnmReleaseRecommend' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.DcnmReleaseRecommend' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.DcnmReleaseRecommend' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.DcnmReleaseRecommend' nullable: true niaapi.DcnmSweol.Response: description: |- The response body of a HTTP GET request for the 'niaapi.DcnmSweol' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.DcnmSweol' resources. x-one-of-name: niaapi.DcnmSweol.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.DcnmSweol.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.DcnmSweol: title: Niaapi:Dcnm Sweol description: |- The software end of life notice for DCNM. x-allOf-name: niaapi.DcnmSweol allOf: - # This 'niaapi.DcnmSweol' class inherits all properties from its parent class niaapi.SoftwareEol. $ref: '#/components/schemas/niaapi.SoftwareEol' niaapi.DcnmSweol.List: title: List of 'niaapi.DcnmSweol' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.DcnmSweol' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.DcnmSweol' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.DcnmSweol' nullable: true niaapi.Detail: title: Niaapi:Detail description: |- The content inside the metadata package with filename and check sum for this file. x-allOf-name: niaapi.Detail allOf: - # This 'niaapi.Detail' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'niaapi.Detail' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.Detail', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.Detail' ObjectType: enum: - 'niaapi.Detail' Chksum: description: |- Checksum of this part of Content. type: string x-omitempty: true Filename: description: |- The file name within this Metadata file. type: string x-omitempty: true Name: description: |- The name of this Content. type: string x-omitempty: true niaapi.FieldNotice: title: Niaapi:Field Notice description: |- This contains the new version release notice. x-allOf-name: niaapi.FieldNotice allOf: - # This 'niaapi.FieldNotice' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.FieldNotice' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.FieldNotice', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Bugid: description: |- Bug Id associated with this notice. type: string x-omitempty: true FieldNoticeDesc: description: |- Field notice Description. type: string x-omitempty: true FieldNoticeId: description: |- Fieldnotice Id of this notice. type: string x-omitempty: true FieldNoticeUrl: description: |- Field notice URL link to the notice webpage. type: string x-omitempty: true Headline: description: |- The headline of this field notice. type: string x-omitempty: true Hwpid: description: |- Hardware PID for affected models. type: string x-omitempty: true RevisionInfo: type: array items: description: |- Revision detail infomation . $ref: '#/components/schemas/niaapi.RevisionInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SwRelease: description: |- Software Release number for affected versions. type: string x-omitempty: true WorkaroundUrl: description: |- URL of workaround of this notice. type: string x-omitempty: true niaapi.FileDownloader.Response: description: |- The response body of a HTTP GET request for the 'niaapi.FileDownloader' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.FileDownloader' resources. x-one-of-name: niaapi.FileDownloader.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.FileDownloader.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.FileDownloader: title: Niaapi:File Downloader description: |- Provide a presigned url to download the metadata file from server. x-allOf-name: niaapi.FileDownloader allOf: - # This 'niaapi.FileDownloader' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.FileDownloader' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.FileDownloader', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.FileDownloader' ObjectType: enum: - 'niaapi.FileDownloader' FileName: description: |- Filename of this Metadata package file, folder will be handled by api. type: string x-omitempty: true PresignedUrl: description: |- The presigned URL from server to download this file. type: string x-omitempty: true niaapi.FileDownloader.List: title: List of 'niaapi.FileDownloader' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.FileDownloader' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.FileDownloader' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.FileDownloader' nullable: true niaapi.HardwareEol: title: Niaapi:Hardware Eol description: |- This contains the end of life notice of hardware. x-allOf-name: niaapi.HardwareEol allOf: - # This 'niaapi.HardwareEol' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.HardwareEol' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.HardwareEol', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AffectedPids: description: |- String contains the PID of hardwares affected by this notice, seperated by comma. type: string x-omitempty: true AnnouncementDate: description: |- When this notice is announced. type: string format: date-time x-omitempty: true AnnouncementDateEpoch: description: |- Epoch time of Announcement Date. type: integer format: int64 x-omitempty: true BulletinNo: description: |- The bulletinno of this hardware end of life notice. type: string x-omitempty: true Description: description: |- The description of this hardware end of life notice. type: string x-omitempty: true EndofNewServiceAttachmentDate: description: |- Date time of end of new services attachment . type: string format: date-time x-omitempty: true EndofNewServiceAttachmentDateEpoch: description: |- Epoch time of New service attachment Date . type: integer format: int64 x-omitempty: true EndofRoutineFailureAnalysisDate: description: |- Date time of end of routinefailure analysis. type: string format: date-time x-omitempty: true EndofRoutineFailureAnalysisDateEpoch: description: |- Epoch time of End of Routine Failure Analysis Date. type: integer format: int64 x-omitempty: true EndofSaleDate: description: |- When this hardware will end sale. type: string format: date-time x-omitempty: true EndofSaleDateEpoch: description: |- Epoch time of End of Sale Date. type: integer format: int64 x-omitempty: true EndofSecuritySupport: description: |- Date time of end of security support . type: string format: date-time x-omitempty: true EndofSecuritySupportEpoch: description: |- Epoch time of End of Security Support Date . type: integer format: int64 x-omitempty: true EndofServiceContractRenewalDate: description: |- Date time of end of service contract renew . type: string format: date-time x-omitempty: true EndofServiceContractRenewalDateEpoch: description: |- Epoch time of End of Renewal service contract. type: integer format: int64 x-omitempty: true EndofSwMaintenanceDate: description: |- The date of end of maintainance. type: string format: date-time x-omitempty: true EndofSwMaintenanceDateEpoch: description: |- Epoch time of End of maintenance Date. type: integer format: int64 x-omitempty: true HardwareEolUrl: description: |- Hardware end of sale URL link to the notice webpage. type: string x-omitempty: true Headline: description: |- The title of this hardware end of life notice. type: string x-omitempty: true LastDateofSupport: description: |- Date time of end of support . type: string format: date-time x-omitempty: true LastDateofSupportEpoch: description: |- Epoch time of last date of support . type: integer format: int64 x-omitempty: true LastShipDate: description: |- Date time of Lastship Date. type: string format: date-time x-omitempty: true LastShipDateEpoch: description: |- Epoch time of last ship Date. type: integer format: int64 x-omitempty: true MigrationUrl: description: |- The URL of this migration notice. type: string x-omitempty: true niaapi.MaintainedRelease: title: Niaapi:Maintained Release description: |- This contains the latest maintained release based on current running software release. x-allOf-name: niaapi.MaintainedRelease allOf: - # This 'niaapi.MaintainedRelease' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.MaintainedRelease' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.MaintainedRelease', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: MaintainedRelease: description: |- Lastest maintained release. type: string x-omitempty: true SoftwareRelease: description: |- Software release version string. type: string x-omitempty: true VersionTag: description: |- Long lived version or short lived version. type: string x-omitempty: true niaapi.NewReleaseDetail: title: Niaapi:New Release Detail description: |- The detail content of of this post. x-allOf-name: niaapi.NewReleaseDetail allOf: - # This 'niaapi.NewReleaseDetail' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'niaapi.NewReleaseDetail' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.NewReleaseDetail', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.NewReleaseDetail' ObjectType: enum: - 'niaapi.NewReleaseDetail' Description: description: |- Description of this new verison release post. type: string x-omitempty: true Link: description: |- Link of downloading the release file. type: string x-omitempty: true ReleaseNoteLink: description: |- The link used to provide a gateway for customer to review the release note. type: string x-omitempty: true ReleaseNoteLinkTitle: description: |- The link title used to provide a gateway for customer to review the release note. type: string x-omitempty: true SoftwareDownloadLink: description: |- The link used to provide a gateway for customer to download the release. type: string x-omitempty: true SoftwareDownloadLinkTitle: description: |- The link title used to provide a gateway for customer to download the release. type: string x-omitempty: true Title: description: |- Title of the new verison release post. type: string x-omitempty: true Version: description: |- Version number Associate with this Post. type: string x-omitempty: true niaapi.NewReleasePost: title: Niaapi:New Release Post description: |- This contains the new release notice. x-allOf-name: niaapi.NewReleasePost allOf: - # This 'niaapi.NewReleasePost' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.NewReleasePost' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.NewReleasePost', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: PostDate: description: |- The date when this new release notice is posted. type: string format: date-time x-omitempty: true PostDetail: description: |- Detail of this post including the content and the date it was posted. $ref: '#/components/schemas/niaapi.NewReleaseDetail' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PostType: description: |- The document type of this post. type: string x-omitempty: true Postid: description: |- Identificator of this inbox post. type: string x-omitempty: true Revision: description: |- Revision number of this notice. type: string x-omitempty: true niaapi.NiaMetadata.Response: description: |- The response body of a HTTP GET request for the 'niaapi.NiaMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.NiaMetadata' resources. x-one-of-name: niaapi.NiaMetadata.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.NiaMetadata.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.NiaMetadata: title: Niaapi:Nia Metadata description: |- Contains the latest Metadata available for download from server. x-allOf-name: niaapi.NiaMetadata allOf: - # This 'niaapi.NiaMetadata' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.NiaMetadata' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.NiaMetadata', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.NiaMetadata' ObjectType: enum: - 'niaapi.NiaMetadata' Content: type: array items: description: |- The detail of child file in this package. $ref: '#/components/schemas/niaapi.Detail' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Date: description: |- The date when this package is generated. type: string format: date-time x-omitempty: true MetadataChksum: description: |- Chksum used to check the integrity of the Metadata file downloaded. type: string x-omitempty: true MetadataFilename: description: |- The Filename of this Metadata package. type: string x-omitempty: true Version: description: |- The version number of the Metadata package. type: integer format: int64 x-omitempty: true niaapi.NiaMetadata.List: title: List of 'niaapi.NiaMetadata' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.NiaMetadata' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.NiaMetadata' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.NiaMetadata' nullable: true niaapi.ReleaseRecommend: title: Niaapi:Release Recommend description: |- This contains the recommend version based on the hardware. x-allOf-name: niaapi.ReleaseRecommend allOf: - # This 'niaapi.ReleaseRecommend' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.ReleaseRecommend' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.ReleaseRecommend', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Cll: description: |- Current long-lived release. type: string x-omitempty: true Crr: description: |- Customer recommended releases. type: string x-omitempty: true Pid: description: |- Hardware model identificator. type: string x-omitempty: true Ull: description: |- Upcoming long-lived release. type: string x-omitempty: true niaapi.RevisionInfo: title: Niaapi:Revision Info description: |- The Revision info including date comment and revision number. x-allOf-name: niaapi.RevisionInfo allOf: - # This 'niaapi.RevisionInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'niaapi.RevisionInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.RevisionInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.RevisionInfo' ObjectType: enum: - 'niaapi.RevisionInfo' DatePublished: description: |- The date the revision is made. type: string format: date-time x-omitempty: true RevisionComment: description: |- The changes made in this revision. type: string x-omitempty: true RevisionNo: description: |- The Revision No. of this revision. type: string x-omitempty: true niaapi.SoftwareEol: title: Niaapi:Software Eol description: |- This contains the end of life notice of software release. x-allOf-name: niaapi.SoftwareEol allOf: - # This 'niaapi.SoftwareEol' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.SoftwareEol' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.SoftwareEol', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AffectedVersions: description: |- String contains the Release versions affected by this notice, seperated by comma. type: string x-omitempty: true AnnouncementDate: description: |- Date time of this notice Announced. type: string format: date-time x-omitempty: true AnnouncementDateEpoch: description: |- Epoch time of this notice Announced. type: integer format: int64 x-omitempty: true BulletinNo: description: |- The bulletinno of this software release end of life notice. type: string x-omitempty: true Description: description: |- The description of this software release end of life notice. type: string x-omitempty: true EndofNewServiceAttachmentDate: description: |- Date time of End of New service attachment . type: string format: date-time x-omitempty: true EndofNewServiceAttachmentDateEpoch: description: |- Epoch time of End of New service attachment . type: integer format: int64 x-omitempty: true EndofServiceContractRenewalDate: description: |- Date time of End of Renewal of service contract . type: string format: date-time x-omitempty: true EndofServiceContractRenewalDateEpoch: description: |- Epoch time of End of Renewal of service contract . type: integer format: int64 x-omitempty: true EndofSwMaintenanceDate: description: |- Date time of End of Maintenance. type: string format: date-time x-omitempty: true EndofSwMaintenanceDateEpoch: description: |- Epoch time of End of Maintenance. type: integer format: int64 x-omitempty: true Headline: description: |- The title of this software release end of life notice. type: string x-omitempty: true LastDateofSupport: description: |- Date time of Last day of Support . type: string format: date-time x-omitempty: true LastDateofSupportEpoch: description: |- Epoch time of Last day of Support . type: integer format: int64 x-omitempty: true LastShipDate: description: |- Date time of Lastship Date. type: string format: date-time x-omitempty: true LastShipDateEpoch: description: |- Epoch time of Lastship Date. type: integer format: int64 x-omitempty: true MigrationUrl: description: |- The URL of this migration notice. type: string x-omitempty: true SoftwareEolUrl: description: |- Software end of life notice URL link to the notice webpage. type: string x-omitempty: true niaapi.SoftwareRegex: title: Niaapi:Software Regex description: |- The regular expression to parse the software version strings. x-allOf-name: niaapi.SoftwareRegex allOf: - # This 'niaapi.SoftwareRegex' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'niaapi.SoftwareRegex' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.SoftwareRegex', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.SoftwareRegex' ObjectType: enum: - 'niaapi.SoftwareRegex' Regex: description: |- Regular Expression pattern used to reconginze the version string. type: string x-omitempty: true SoftwareVersion: description: |- Software release. A set of Software releases seperated by comma which can be recongized by according Regex pattern. type: string x-omitempty: true niaapi.VersionRegex.Response: description: |- The response body of a HTTP GET request for the 'niaapi.VersionRegex' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niaapi.VersionRegex' resources. x-one-of-name: niaapi.VersionRegex.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niaapi.VersionRegex.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niaapi.VersionRegex: title: Niaapi:Version Regex description: |- The regular expression pattern to recongnize the version string. x-allOf-name: niaapi.VersionRegex allOf: - # This 'niaapi.VersionRegex' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niaapi.VersionRegex' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.VersionRegex', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.VersionRegex' ObjectType: enum: - 'niaapi.VersionRegex' Apic: description: |- Version Regex mapping for APIC platform. $ref: '#/components/schemas/niaapi.VersionRegexPlatform' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Dcnm: description: |- Version Regex mapping for DCNM platform. $ref: '#/components/schemas/niaapi.VersionRegexPlatform' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Version: description: |- Version number for the Version Regex data, also used as identity. type: string x-omitempty: true niaapi.VersionRegex.List: title: List of 'niaapi.VersionRegex' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niaapi.VersionRegex' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niaapi.VersionRegex' resources matching the request. type: array items: $ref: '#/components/schemas/niaapi.VersionRegex' nullable: true niaapi.VersionRegexPlatform: title: Niaapi:Version Regex Platform description: |- The regular expression to parse the software version strings for specific platform. x-allOf-name: niaapi.VersionRegexPlatform allOf: - # This 'niaapi.VersionRegexPlatform' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'niaapi.VersionRegexPlatform' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niaapi.VersionRegexPlatform', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niaapi.VersionRegexPlatform' ObjectType: enum: - 'niaapi.VersionRegexPlatform' Anyllregex: description: |- All long live version Regex pattern. type: string x-omitempty: true Currentlltrain: description: |- Current long live version Regex pattern. $ref: '#/components/schemas/niaapi.SoftwareRegex' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Latestsltrain: description: |- Latest short live version Regex pattern. $ref: '#/components/schemas/niaapi.SoftwareRegex' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Sltrain: type: array items: description: |- List of short lived verison and Regex pattern. $ref: '#/components/schemas/niaapi.SoftwareRegex' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Upcominglltrain: description: |- Upcoming short live version Regex pattern. $ref: '#/components/schemas/niaapi.SoftwareRegex' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true niatelemetry.Diskinfo: title: Niatelemetry:Diskinfo description: |- Object that carries all the fields needed for Disk usage. This determines the usage of disk capacity of a device. x-allOf-name: niatelemetry.Diskinfo allOf: - # This 'niatelemetry.Diskinfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'niatelemetry.Diskinfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niatelemetry.Diskinfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niatelemetry.Diskinfo' ObjectType: enum: - 'niatelemetry.Diskinfo' Free: description: |- The free disk capacity, currently the type of this field is set to integer. This determines how much memory is free in Bytes. type: integer format: int64 x-omitempty: true Name: description: |- Disk Name used to identified the disk usage record. This determines the name of the disk partition that is inventoried. type: string x-omitempty: true Total: description: |- The total disk capacity, it should be the sum of free and used, currently the type of this field is set to integer. This determines the total memory for this partition. type: integer format: int64 x-omitempty: true Used: description: |- The used disk capacity, currently the type of this field is set to integer. This determines how much memory is used in Bytes. type: integer format: int64 x-omitempty: true niatelemetry.Epg.Response: description: |- The response body of a HTTP GET request for the 'niatelemetry.Epg' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niatelemetry.Epg' resources. x-one-of-name: niatelemetry.Epg.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niatelemetry.Epg.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niatelemetry.Epg: title: Niatelemetry:Epg description: |- Object is available at End Point Group scope. This currently applies only to the APIC environemt. x-allOf-name: niatelemetry.Epg allOf: - # This 'niatelemetry.Epg' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niatelemetry.Epg' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niatelemetry.Epg', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niatelemetry.Epg' ObjectType: enum: - 'niatelemetry.Epg' AzurePackCount: description: |- Azure Pack NAT with ASA feature usage. type: integer format: int64 x-omitempty: true Dn: description: |- Dn value for the End Point Groups present. type: string x-omitempty: true EpgDelimiterCount: description: |- EPG Delimiter scale where the delimiter value is present. type: integer format: int64 x-omitempty: true FcNpvCount: description: |- Number of ports with FC path attribute of type FC. type: integer format: int64 x-omitempty: true FcoeCount: description: |- Number of FCoE per End Point Group. type: string x-omitempty: true FvRsDomAttCount: description: |- FvRsDomAtt scale per End Point Group with VMware configured. type: integer format: int64 x-omitempty: true IntraEpgDvsBmCount: description: |- Intra End Point Group Contract for Distributed Virtual Switch and BM feature usage. type: integer format: int64 x-omitempty: true IntraEpgHyperv: description: |- Intra EPG Isolation for Hyper-V, enabled if pcEnfPref attribute is set to enforced. type: string x-omitempty: true IsAttrBased: description: |- Gets the state of End Point Groups with isAttrBasedEPg value as configured. type: string x-omitempty: true Microsegmentation: description: |- Gets the state of End Point Groups where microsegmentation is present. type: string x-omitempty: true MicrosoftUsegCount: description: |- FvRsDomAtt scale per End Point Group with Microsoft configured. type: integer format: int64 x-omitempty: true Name: description: |- Name value for the End Point Groups present. type: string x-omitempty: true OrchslDevVipCfgCount: description: |- Simplified Service Graph Integration with Windows Azure Pack count scale. type: integer format: int64 x-omitempty: true SiteName: description: |- The Site name represents an APIC cluster. Service Engine can onboard multiple APIC clusters / sites. type: string x-omitempty: true UsegHypervCount: description: |- Logical Operators for attribute based microsegmentation in a hypervisor. type: integer format: int64 x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true niatelemetry.Epg.List: title: List of 'niatelemetry.Epg' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niatelemetry.Epg' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niatelemetry.Epg' resources matching the request. type: array items: $ref: '#/components/schemas/niatelemetry.Epg' nullable: true niatelemetry.NiaFeatureUsage.Response: description: |- The response body of a HTTP GET request for the 'niatelemetry.NiaFeatureUsage' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niatelemetry.NiaFeatureUsage' resources. x-one-of-name: niatelemetry.NiaFeatureUsage.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niatelemetry.NiaFeatureUsage.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niatelemetry.NiaFeatureUsage: title: Niatelemetry:Nia Feature Usage description: |- Object available at Device connector scope for feature and fabric information. This applies to APIC environment currently. x-allOf-name: niatelemetry.NiaFeatureUsage allOf: - # This 'niatelemetry.NiaFeatureUsage' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niatelemetry.NiaFeatureUsage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niatelemetry.NiaFeatureUsage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niatelemetry.NiaFeatureUsage' ObjectType: enum: - 'niatelemetry.NiaFeatureUsage' ApicCount: description: |- Number of APIC controllers. This determines the value of controllers for the fabric. type: integer format: int64 x-omitempty: true AppCenterCount: description: |- ACI APPs feature usage scale. type: integer format: int64 x-omitempty: true Ave: description: |- AVE feature usage. This determines if ACI virtual edge feature is enabled or disabled. type: string x-omitempty: true BdCount: description: |- Number of BDs. This determines the total number of Broadcast Domains across the fabric. type: integer format: int64 x-omitempty: true CloudSecPeerCount: description: |- Number of Cloudsec SA peers. type: integer format: int64 x-omitempty: true ConsistencyCheckerApp: description: |- Consistency checker application usage. This determines if the fabric has Consistency checker application installed. type: string x-omitempty: true ContractCount: description: |- Number of contracts. This determines the total number of Contracts configured across the fabric. type: integer format: int64 x-omitempty: true DnsCount: description: |- DNS feature usage. This determines the total number of DNS configurations across the fabric. type: integer format: int64 x-omitempty: true EigrpCount: description: |- Eigrp feature usage. This determines the total number of EIGRP sessions across the fabric. type: integer format: int64 x-omitempty: true EpgCount: description: |- Number of End Point Groups. This determines the total number of End Point Groups across the fabric. type: integer format: int64 x-omitempty: true FcoeNportCount: description: |- Total number of FCoE N-Port for DOM, VSAn, and VLAN. type: integer format: int64 x-omitempty: true FcoeNportDomCount: description: |- Number of FCoE N-Port DOM. type: integer format: int64 x-omitempty: true FcoeNportVlanCount: description: |- Number of FCoE N-Port VLAN. type: integer format: int64 x-omitempty: true FcoeNportVsanCount: description: |- Number of FCoE N-Port VSAN. type: integer format: int64 x-omitempty: true HsrpCount: description: |- Hsrp feature usage. This determines the total number of HSRP sessions across the fabric. type: integer format: int64 x-omitempty: true IbgpCount: description: |- Ibgp feature usage. This determines the total number of BGP sessions across the fabric. type: integer format: int64 x-omitempty: true IgmpAccessListCount: description: |- IGMP Access List feature usage. This determines the total number of IGMP access lists configured across the fabric. type: integer format: int64 x-omitempty: true IgmpSnoop: description: |- IGMP Snooping feature usage. This determines if this feature is enabled or disabled. type: string x-omitempty: true IpEpgCount: description: |- Number of IP based End Point Groups. This determines the total number of IP End Point Groups across the fabric. type: integer format: int64 x-omitempty: true IsisCount: description: |- Isis feature usage. This determines the total number of ISIS sessions across the fabric. type: integer format: int64 x-omitempty: true L2Multicast: description: |- L2Multicast feature usage. This determines if this Layer 2 Multicast feature is being enabled / disabled on the fabric. type: string x-omitempty: true LeafCount: description: |- Number of Leafs. This determines the total number of Leaf switches in the fabric. type: integer format: int64 x-omitempty: true MaintenanceModeCount: description: |- Maintenance Mode feature usage. This determines the number of switches that are currently in maintenance mode. type: integer format: int64 x-omitempty: true ManagementOverV6Count: description: |- Management over IPv6 feature usage. This determines the total number of IPv6 configurtaions in the fabric. type: integer format: int64 x-omitempty: true MicrosoftUsegVmmEpPdCount: description: |- Microsoft microsegmentation VmmEpPD scale. Ensures that Microsoft was configured. type: integer format: int64 x-omitempty: true NetFlowCount: description: |- Number of Netflow monitor policies. type: integer format: int64 x-omitempty: true Nir: description: |- NIR application usage. This determines if the fabric has NIR application installed. type: string x-omitempty: true OpenStack: description: |- Open stack feature usage. type: string x-omitempty: true OpflexKubernetesCount: description: |- Opflex for Kubernetes feature usage. This determines the total number of VMM sessions of type kubernetes. type: integer format: int64 x-omitempty: true OspfCount: description: |- Ospf feature usage. This determines the total number of OSPF sessions across the fabric. type: integer format: int64 x-omitempty: true PoeCount: description: |- POE feature usage. This determines the total number of POE configurations across the fabric. type: integer format: int64 x-omitempty: true PortSecurityCount: description: |- Port Security count scale. Non-Zero value indicates the object as enabled. type: integer format: int64 x-omitempty: true QinVniTunnelCount: description: |- QinVniTunnel feature usage. This determines if the qinVniTunnel feature is being used on the fabric and the scale of it. type: integer format: int64 x-omitempty: true RemoteLeafCount: description: |- Number of remote Leafs. This determines the total number of remote leaf switches in the fabric. type: integer format: int64 x-omitempty: true ScvmmCount: description: |- SCVMM feature usage. This determines the total number of SCVMM configurations in the fabric. type: integer format: int64 x-omitempty: true SharedL3OutCount: description: |- SharedL3Out feature usage. This determines the total number of Shared L3 out configured across the fabric. type: integer format: int64 x-omitempty: true SiteName: description: |- The Site name represents an APIC cluster. Service Engine can onboard multiple APIC clusters / sites. There will be a feature usage object per site in Multi site scenario. In multi-site scenario the site name is available in all the requests being made. type: string x-omitempty: true SmartCallHome: description: |- Smart callhome feature usage. This determines if this feature is being enabled or disabled. type: string x-omitempty: true Snmp: description: |- SNMP feature usage. This determines if this feature is enabled or disabled. type: string x-omitempty: true SpanCount: description: |- Number of Span Sources and Destinations. type: integer format: int64 x-omitempty: true SpanDstCount: description: |- Number of Span Destinations with valid state. type: integer format: int64 x-omitempty: true SpanSrcCount: description: |- Number of Span Sources with valid state. type: integer format: int64 x-omitempty: true SpineCount: description: |- Number of Spines. This determines the total number of spine switches in the fabric. type: integer format: int64 x-omitempty: true SshOverV6Count: description: |- Ssh over IPv6 feature usage. This determines the total number of IPv6 configurtaions in the fabric. type: integer format: int64 x-omitempty: true SyslogOverV6Count: description: |- Syslog over IPv6 feature usage. This determines the total number of IPv6 configurtaions in the fabric. type: integer format: int64 x-omitempty: true TenantCount: description: |- Number of tenants. This determines the total number of tenants configured across the fabric. type: integer format: int64 x-omitempty: true TierTwoLeafCount: description: |- Number of tier 2 Leafs. This determines the total number of tier 2 Leaf switches in the fabric. type: integer format: int64 x-omitempty: true Twamp: description: |- TWAMP feature usage. This determines if this feature is enabled or disabled. type: string x-omitempty: true Useg: description: |- VMM uSegmentation feature usage. This determines if microsegmentation feature is enabled or disabled. type: string x-omitempty: true VmWareVdsCount: description: |- VmWare vCenter 6.5 support count scale. Checks the controller revision value. type: integer format: int64 x-omitempty: true VmmCtrlrpCount: description: |- Gets the scale for Virtual Machine Monitor controller policy for VMware vCenter. type: integer format: int64 x-omitempty: true VmmDompCount: description: |- Obtains the scale for Virtual Machine Monitor domain policy model for VMware vCenter. type: integer format: int64 x-omitempty: true VmmEpPdCount: description: |- Microsegmentation Distributed Virtual Switch feature usage. Gets the scale for VMware vCenter. type: integer format: int64 x-omitempty: true VnsmDevCount: description: |- L4-L7 Device Package Import count scale. Checks for the vendor and the model. type: integer format: int64 x-omitempty: true VpodCount: description: |- Virtual pod feature usage. This determines the total number of virtual POD configurations in the fabrics. type: integer format: int64 x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true niatelemetry.NiaFeatureUsage.List: title: List of 'niatelemetry.NiaFeatureUsage' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niatelemetry.NiaFeatureUsage' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niatelemetry.NiaFeatureUsage' resources matching the request. type: array items: $ref: '#/components/schemas/niatelemetry.NiaFeatureUsage' nullable: true niatelemetry.NiaInventory.Response: description: |- The response body of a HTTP GET request for the 'niatelemetry.NiaInventory' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niatelemetry.NiaInventory' resources. x-one-of-name: niatelemetry.NiaInventory.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niatelemetry.NiaInventory.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niatelemetry.NiaInventory.Relationship: description: A relationship to the 'niatelemetry.NiaInventory' resource, or the expanded 'niatelemetry.NiaInventory' resource, or the 'null' value. x-one-of-name: niatelemetry.NiaInventory.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/niatelemetry.NiaInventory' niatelemetry.NiaInventory: title: Niatelemetry:Nia Inventory description: |- Inventory object available per device scope. This common object holds a device level information. x-allOf-name: niatelemetry.NiaInventory allOf: - # This 'niatelemetry.NiaInventory' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niatelemetry.NiaInventory' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niatelemetry.NiaInventory', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niatelemetry.NiaInventory' ObjectType: enum: - 'niatelemetry.NiaInventory' Cpu: description: |- CPU usage of device being inventoried. This determines the percentage of CPU resources used. type: number format: float x-omitempty: true CrashResetLogs: description: |- Last crash reset reason of device being inventoried. This determines the last reason for a device's restart due to crash of the system. type: string x-omitempty: true DeviceName: description: |- Name of device being inventoried. The name the user assigns to the device is inventoried here. type: string x-omitempty: true DeviceType: description: |- Type of device being inventoried. This determines whether the device is a controller, leaf or spine. type: string x-omitempty: true Disk: description: |- Disk Usage of device being inventoried. This determines the amount of disk usage. $ref: '#/components/schemas/niatelemetry.Diskinfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true FexCount: description: |- Scale of fabric extendors utilized. type: integer format: int64 x-omitempty: true LogInTime: description: |- Last log in time device being inventoried. This determines the last login time on the device. type: string x-omitempty: true LogOutTime: description: |- Last log out time of device being inventoried. This determines the last logout time on the device. type: string x-omitempty: true MacSecCount: description: |- Number of Macsec configured interfaces on a TOR. type: integer format: int64 x-omitempty: true MacSecFabCount: description: |- Number of Macsec configured interfaces on a Spine. type: integer format: int64 x-omitempty: true MacsecTotalCount: description: |- Number of total Macsec configured interfaces for all nodes. type: integer format: int64 x-omitempty: true Memory: description: |- Memory usage of device being inventoried. This determines the percentage of memory resources used. type: integer format: int64 x-omitempty: true RecordType: description: |- Type of record DCNM / APIC / SE. This determines the type of platform where inventory was collected. type: string x-omitempty: true RecordVersion: description: |- Version of record being pushed. This determines what was the API version for data available from the device. type: string x-omitempty: true RoutePrefixCount: description: |- Total nuumber of v4 and v6 routes per node. type: integer format: int64 x-omitempty: true RoutePrefixV4Count: description: |- Scale of v4 routes per node. type: integer format: int64 x-omitempty: true RoutePrefixV6Count: description: |- Scale of v6 routes per node. type: integer format: int64 x-omitempty: true Serial: description: |- Serial number of device being invetoried. The serial number is unique per device and will be used as the key. type: string x-omitempty: true SoftwareDownload: description: |- Last software downloaded of device being inventoried. This determines if software download API was used. type: string x-omitempty: true Version: description: |- Software version of device being inventoried. The various software version values for each device are available on cisco.com. type: string x-omitempty: true LicenseState: # A Relationship to MO niatelemetry.NiaLicenseState $ref: '#/components/schemas/niatelemetry.NiaLicenseState.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a niatelemetryNiaLicenseState resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true niatelemetry.NiaInventory.List: title: List of 'niatelemetry.NiaInventory' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niatelemetry.NiaInventory' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niatelemetry.NiaInventory' resources matching the request. type: array items: $ref: '#/components/schemas/niatelemetry.NiaInventory' nullable: true niatelemetry.NiaLicenseState.Response: description: |- The response body of a HTTP GET request for the 'niatelemetry.NiaLicenseState' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niatelemetry.NiaLicenseState' resources. x-one-of-name: niatelemetry.NiaLicenseState.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niatelemetry.NiaLicenseState.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niatelemetry.NiaLicenseState.Relationship: description: A relationship to the 'niatelemetry.NiaLicenseState' resource, or the expanded 'niatelemetry.NiaLicenseState' resource, or the 'null' value. x-one-of-name: niatelemetry.NiaLicenseState.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/niatelemetry.NiaLicenseState' niatelemetry.NiaLicenseState: title: Niatelemetry:Nia License State description: |- Object available at device scope for license information. This determines the usage of this attribute. x-allOf-name: niatelemetry.NiaLicenseState allOf: - # This 'niatelemetry.NiaLicenseState' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niatelemetry.NiaLicenseState' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niatelemetry.NiaLicenseState', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niatelemetry.NiaLicenseState' ObjectType: enum: - 'niatelemetry.NiaLicenseState' FeatureActivated: description: |- Features activated on device being inventoried. This determines which features are currently enabled on the device that the license API can check. type: string x-omitempty: true LicenseActivated: description: |- Licenses activated on device being inventoried. This determines which lienceses are currently enabled on the device. type: string x-omitempty: true PidType: description: |- PID of device being inventoried. This determines the hardware model type of the device. type: string x-omitempty: true Serial: description: |- Serial number of device being inventoried. The serial number is unique per device. type: string x-omitempty: true Device: # A Relationship to MO niatelemetry.NiaInventory $ref: '#/components/schemas/niatelemetry.NiaInventory.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a niatelemetryNiaInventory resource. When the $expand query parameter is specified, the referenced resource is returned inline. niatelemetry.NiaLicenseState.List: title: List of 'niatelemetry.NiaLicenseState' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niatelemetry.NiaLicenseState' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niatelemetry.NiaLicenseState' resources matching the request. type: array items: $ref: '#/components/schemas/niatelemetry.NiaLicenseState' nullable: true niatelemetry.Tenant.Response: description: |- The response body of a HTTP GET request for the 'niatelemetry.Tenant' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'niatelemetry.Tenant' resources. x-one-of-name: niatelemetry.Tenant.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/niatelemetry.Tenant.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType niatelemetry.Tenant: title: Niatelemetry:Tenant description: |- Object is available at Tenant scope. This currently applies only to the APIC environemt. x-allOf-name: niatelemetry.Tenant allOf: - # This 'niatelemetry.Tenant' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'niatelemetry.Tenant' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'niatelemetry.Tenant', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'niatelemetry.Tenant' ObjectType: enum: - 'niatelemetry.Tenant' BfdIfPolCount: description: |- Bidirectional Forwarding Detection bfdIfPol Model Object count scale. type: integer format: int64 x-omitempty: true BfdIfpCount: description: |- Bidirectional Forwarding Detection Interface Policy count scale. type: integer format: int64 x-omitempty: true Dn: description: |- Dn for the tenants present. type: string x-omitempty: true FhsBdPolCount: description: |- First hop security count scale. Checks for presence of IP source gaurd, dynamic arp inspection. type: integer format: int64 x-omitempty: true FvRsBdToFhsCount: description: |- First hop security count scale. Checks for presence of IP source gaurd, dynamic arp inspection. type: integer format: int64 x-omitempty: true FvSiteConnpCount: description: |- Multi-Site scale for fvSiteConnp Model Object. type: integer format: int64 x-omitempty: true L3MulticastCount: description: |- Number of layer 3 multicasts. type: integer format: int64 x-omitempty: true L3MulticastCtxCount: description: |- Number of layer 3 multicast CtxP. type: integer format: int64 x-omitempty: true L3MulticastIfCount: description: |- Number of layer 3 multicast IfP. type: integer format: int64 x-omitempty: true L3outCount: description: |- L3 out scale for the tenants present. type: integer format: int64 x-omitempty: true SiteName: description: |- The Site name represents an APIC cluster. Service Engine can onboard multiple APIC clusters / sites. type: string x-omitempty: true Ssm: description: |- SSM property feature usage. type: string x-omitempty: true TraceRouteEpCount: description: |- Number of ITrace route endpoint per tenant. type: integer format: int64 x-omitempty: true TraceRouteEpExtCount: description: |- Number of ITrace endpoint external routes per tenant. type: integer format: int64 x-omitempty: true TraceRouteExtEpCount: description: |- Number of ITrace external endpoint routes per tenant. type: integer format: int64 x-omitempty: true TraceRouteExtExtCount: description: |- Number of ITrace external routes per tenant. type: integer format: int64 x-omitempty: true VnsAbsGraphCount: description: |- L4 to L7 Services graph count scale. type: integer format: int64 x-omitempty: true VnsBackupPolCount: description: |- Policy Based Routing standby Node count scale. Checks the Policy Based Routing backup policy. type: integer format: int64 x-omitempty: true VnsRedirectDestCount: description: |- Policy Based Routing standby Node count scale. Policy based redirect requires a destination to redirect traffic. type: integer format: int64 x-omitempty: true VnsSvcRedirectPolCount: description: |- Policy Based Routing and Policy Based Service Insertion count scale. Includes without L4-L7 package. type: integer format: int64 x-omitempty: true VrfCount: description: |- Vrf scale count per tenant. type: integer format: int64 x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true niatelemetry.Tenant.List: title: List of 'niatelemetry.Tenant' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'niatelemetry.Tenant' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'niatelemetry.Tenant' resources matching the request. type: array items: $ref: '#/components/schemas/niatelemetry.Tenant' nullable: true ntp.Policy.Response: description: |- The response body of a HTTP GET request for the 'ntp.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ntp.Policy' resources. x-one-of-name: ntp.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ntp.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ntp.Policy: title: NTP description: |- Policy to configure the NTP Servers. x-allOf-name: ntp.Policy allOf: - # This 'ntp.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'ntp.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ntp.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ntp.Policy' ObjectType: enum: - 'ntp.Policy' Enabled: description: |- State of NTP service on the endpoint. type: boolean x-omitempty: true NtpServers: type: array items: description: |- Collection of NTP Server IP addresses or hostnames. type: string x-omitempty: true maxItems: 4 Timezone: description: "Timezone of services on the endpoint.\n* `Pacific/Niue` - \n* `Pacific/Pago_Pago` - \n* `Pacific/Honolulu` - \n* `Pacific/Rarotonga` - \n* `Pacific/Tahiti` - \n* `Pacific/Marquesas` - \n* `America/Anchorage` - \n* `Pacific/Gambier` - \n* `America/Los_Angeles` - \n* `America/Tijuana` - \n* `America/Vancouver` - \n* `America/Whitehorse` - \n* `Pacific/Pitcairn` - \n* `America/Dawson_Creek` - \n* `America/Denver` - \n* `America/Edmonton` - \n* `America/Hermosillo` - \n* `America/Mazatlan` - \n* `America/Phoenix` - \n* `America/Yellowknife` - \n* `America/Belize` - \n* `America/Chicago` - \n* `America/Costa_Rica` - \n* `America/El_Salvador` - \n* `America/Guatemala` - \n* `America/Managua` - \n* `America/Mexico_City` - \n* `America/Regina` - \n* `America/Tegucigalpa` - \n* `America/Winnipeg` - \n* `Pacific/Galapagos` - \n* `America/Bogota` - \n* `America/Cancun` - \n* `America/Cayman` - \n* `America/Guayaquil` - \n* `America/Havana` - \n* `America/Iqaluit` - \n* `America/Jamaica` - \n* `America/Lima` - \n* `America/Nassau` - \n* `America/New_York` - \n* `America/Panama` - \n* `America/Port-au-Prince` - \n* `America/Rio_Branco` - \n* `America/Toronto` - \n* `Pacific/Easter` - \n* `America/Caracas` - \n* `America/Asuncion` - \n* `America/Barbados` - \n* `America/Boa_Vista` - \n* `America/Campo_Grande` - \n* `America/Cuiaba` - \n* `America/Curacao` - \n* `America/Grand_Turk` - \n* `America/Guyana` - \n* `America/Halifax` - \n* `America/La_Paz` - \n* `America/Manaus` - \n* `America/Martinique` - \n* `America/Port_of_Spain` - \n* `America/Porto_Velho` - \n* `America/Puerto_Rico` - \n* `America/Santo_Domingo` - \n* `America/Thule` - \n* `Atlantic/Bermuda` - \n* `America/St_Johns` - \n* `America/Araguaina` - \n* `America/Argentina/Buenos_Aires` - \n* `America/Bahia` - \n* `America/Belem` - \n* `America/Cayenne` - \n* `America/Fortaleza` - \n* `America/Godthab` - \n* `America/Maceio` - \n* `America/Miquelon` - \n* `America/Montevideo` - \n* `America/Paramaribo` - \n* `America/Recife` - \n* `America/Santiago` - \n* `America/Sao_Paulo` - \n* `Antarctica/Palmer` - \n* `Antarctica/Rothera` - \n* `Atlantic/Stanley` - \n* `America/Noronha` - \n* `Atlantic/South_Georgia` - \n* `America/Scoresbysund` - \n* `Atlantic/Azores` - \n* `Atlantic/Cape_Verde` - \n* `Africa/Abidjan` - \n* `Africa/Accra` - \n* `Africa/Bissau` - \n* `Africa/Casablanca` - \n* `Africa/El_Aaiun` - \n* `Africa/Monrovia` - \n* `America/Danmarkshavn` - \n* `Atlantic/Canary` - \n* `Atlantic/Faroe` - \n* `Atlantic/Reykjavik` - \n* `Etc/GMT` - \n* `Europe/Dublin` - \n* `Europe/Lisbon` - \n* `Europe/London` - \n* `Africa/Algiers` - \n* `Africa/Ceuta` - \n* `Africa/Lagos` - \n* `Africa/Ndjamena` - \n* `Africa/Tunis` - \n* `Africa/Windhoek` - \n* `Europe/Amsterdam` - \n* `Europe/Andorra` - \n* `Europe/Belgrade` - \n* `Europe/Berlin` - \n* `Europe/Brussels` - \n* `Europe/Budapest` - \n* `Europe/Copenhagen` - \n* `Europe/Gibraltar` - \n* `Europe/Luxembourg` - \n* `Europe/Madrid` - \n* `Europe/Malta` - \n* `Europe/Monaco` - \n* `Europe/Oslo` - \n* `Europe/Paris` - \n* `Europe/Prague` - \n* `Europe/Rome` - \n* `Europe/Stockholm` - \n* `Europe/Tirane` - \n* `Europe/Vienna` - \n* `Europe/Warsaw` - \n* `Europe/Zurich` - \n* `Africa/Cairo` - \n* `Africa/Johannesburg` - \n* `Africa/Maputo` - \n* `Africa/Tripoli` - \n* `Asia/Amman` - \n* `Asia/Beirut` - \n* `Asia/Damascus` - \n* `Asia/Gaza` - \n* `Asia/Jerusalem` - \n* `Asia/Nicosia` - \n* `Europe/Athens` - \n* `Europe/Bucharest` - \n* `Europe/Chisinau` - \n* `Europe/Helsinki` - \n* `Europe/Istanbul` - \n* `Europe/Kaliningrad` - \n* `Europe/Kiev` - \n* `Europe/Riga` - \n* `Europe/Sofia` - \n* `Europe/Tallinn` - \n* `Europe/Vilnius` - \n* `Africa/Khartoum` - \n* `Africa/Nairobi` - \n* `Antarctica/Syowa` - \n* `Asia/Baghdad` - \n* `Asia/Qatar` - \n* `Asia/Riyadh` - \n* `Europe/Minsk` - \n* `Europe/Moscow` - \n* `Asia/Tehran` - \n* `Asia/Baku` - \n* `Asia/Dubai` - \n* `Asia/Tbilisi` - \n* `Asia/Yerevan` - \n* `Europe/Samara` - \n* `Indian/Mahe` - \n* `Indian/Mauritius` - \n* `Indian/Reunion` - \n* `Asia/Kabul` - \n* `Antarctica/Mawson` - \n* `Asia/Aqtau` - \n* `Asia/Aqtobe` - \n* `Asia/Ashgabat` - \n* `Asia/Dushanbe` - \n* `Asia/Karachi` - \n* `Asia/Tashkent` - \n* `Asia/Yekaterinburg` - \n* `Indian/Kerguelen` - \n* `Indian/Maldives` - \n* `Asia/Calcutta` - \n* `Asia/Kolkata` - \n* `Asia/Colombo` - \n* `Asia/Katmandu` - \n* `Antarctica/Vostok` - \n* `Asia/Almaty` - \n* `Asia/Bishkek` - \n* `Asia/Dhaka` - \n* `Asia/Omsk` - \n* `Asia/Thimphu` - \n* `Indian/Chagos` - \n* `Asia/Rangoon` - \n* `Indian/Cocos` - \n* `Antarctica/Davis` - \n* `Asia/Bangkok` - \n* `Asia/Hovd` - \n* `Asia/Jakarta` - \n* `Asia/Krasnoyarsk` - \n* `Asia/Saigon` - \n* `Indian/Christmas` - \n* `Antarctica/Casey` - \n* `Asia/Brunei` - \n* `Asia/Choibalsan` - \n* `Asia/Hong_Kong` - \n* `Asia/Irkutsk` - \n* `Asia/Kuala_Lumpur` - \n* `Asia/Macau` - \n* `Asia/Makassar` - \n* `Asia/Manila` - \n* `Asia/Shanghai` - \n* `Asia/Singapore` - \n* `Asia/Taipei` - \n* `Asia/Ulaanbaatar` - \n* `Australia/Perth` - \n* `Asia/Pyongyang` - \n* `Asia/Dili` - \n* `Asia/Jayapura` - \n* `Asia/Seoul` - \n* `Asia/Tokyo` - \n* `Asia/Yakutsk` - \n* `Pacific/Palau` - \n* `Australia/Adelaide` - \n* `Australia/Darwin` - \n* `Antarctica/DumontDUrville` - \n* `Asia/Magadan` - \n* `Asia/Vladivostok` - \n* `Australia/Brisbane` - \n* `Australia/Hobart` - \n* `Australia/Sydney` - \n* `Pacific/Chuuk` - \n* `Pacific/Guam` - \n* `Pacific/Port_Moresby` - \n* `Pacific/Efate` - \n* `Pacific/Guadalcanal` - \n* `Pacific/Kosrae` - \n* `Pacific/Norfolk` - \n* `Pacific/Noumea` - \n* `Pacific/Pohnpei` - \n* `Asia/Kamchatka` - \n* `Pacific/Auckland` - \n* `Pacific/Fiji` - \n* `Pacific/Funafuti` - \n* `Pacific/Kwajalein` - \n* `Pacific/Majuro` - \n* `Pacific/Nauru` - \n* `Pacific/Tarawa` - \n* `Pacific/Wake` - \n* `Pacific/Wallis` - \n* `Pacific/Apia` - \n* `Pacific/Enderbury` - \n* `Pacific/Fakaofo` - \n* `Pacific/Tongatapu` - \n* `Pacific/Kiritimati` -" type: string enum: - 'Pacific/Niue' - 'Pacific/Pago_Pago' - 'Pacific/Honolulu' - 'Pacific/Rarotonga' - 'Pacific/Tahiti' - 'Pacific/Marquesas' - 'America/Anchorage' - 'Pacific/Gambier' - 'America/Los_Angeles' - 'America/Tijuana' - 'America/Vancouver' - 'America/Whitehorse' - 'Pacific/Pitcairn' - 'America/Dawson_Creek' - 'America/Denver' - 'America/Edmonton' - 'America/Hermosillo' - 'America/Mazatlan' - 'America/Phoenix' - 'America/Yellowknife' - 'America/Belize' - 'America/Chicago' - 'America/Costa_Rica' - 'America/El_Salvador' - 'America/Guatemala' - 'America/Managua' - 'America/Mexico_City' - 'America/Regina' - 'America/Tegucigalpa' - 'America/Winnipeg' - 'Pacific/Galapagos' - 'America/Bogota' - 'America/Cancun' - 'America/Cayman' - 'America/Guayaquil' - 'America/Havana' - 'America/Iqaluit' - 'America/Jamaica' - 'America/Lima' - 'America/Nassau' - 'America/New_York' - 'America/Panama' - 'America/Port-au-Prince' - 'America/Rio_Branco' - 'America/Toronto' - 'Pacific/Easter' - 'America/Caracas' - 'America/Asuncion' - 'America/Barbados' - 'America/Boa_Vista' - 'America/Campo_Grande' - 'America/Cuiaba' - 'America/Curacao' - 'America/Grand_Turk' - 'America/Guyana' - 'America/Halifax' - 'America/La_Paz' - 'America/Manaus' - 'America/Martinique' - 'America/Port_of_Spain' - 'America/Porto_Velho' - 'America/Puerto_Rico' - 'America/Santo_Domingo' - 'America/Thule' - 'Atlantic/Bermuda' - 'America/St_Johns' - 'America/Araguaina' - 'America/Argentina/Buenos_Aires' - 'America/Bahia' - 'America/Belem' - 'America/Cayenne' - 'America/Fortaleza' - 'America/Godthab' - 'America/Maceio' - 'America/Miquelon' - 'America/Montevideo' - 'America/Paramaribo' - 'America/Recife' - 'America/Santiago' - 'America/Sao_Paulo' - 'Antarctica/Palmer' - 'Antarctica/Rothera' - 'Atlantic/Stanley' - 'America/Noronha' - 'Atlantic/South_Georgia' - 'America/Scoresbysund' - 'Atlantic/Azores' - 'Atlantic/Cape_Verde' - 'Africa/Abidjan' - 'Africa/Accra' - 'Africa/Bissau' - 'Africa/Casablanca' - 'Africa/El_Aaiun' - 'Africa/Monrovia' - 'America/Danmarkshavn' - 'Atlantic/Canary' - 'Atlantic/Faroe' - 'Atlantic/Reykjavik' - 'Etc/GMT' - 'Europe/Dublin' - 'Europe/Lisbon' - 'Europe/London' - 'Africa/Algiers' - 'Africa/Ceuta' - 'Africa/Lagos' - 'Africa/Ndjamena' - 'Africa/Tunis' - 'Africa/Windhoek' - 'Europe/Amsterdam' - 'Europe/Andorra' - 'Europe/Belgrade' - 'Europe/Berlin' - 'Europe/Brussels' - 'Europe/Budapest' - 'Europe/Copenhagen' - 'Europe/Gibraltar' - 'Europe/Luxembourg' - 'Europe/Madrid' - 'Europe/Malta' - 'Europe/Monaco' - 'Europe/Oslo' - 'Europe/Paris' - 'Europe/Prague' - 'Europe/Rome' - 'Europe/Stockholm' - 'Europe/Tirane' - 'Europe/Vienna' - 'Europe/Warsaw' - 'Europe/Zurich' - 'Africa/Cairo' - 'Africa/Johannesburg' - 'Africa/Maputo' - 'Africa/Tripoli' - 'Asia/Amman' - 'Asia/Beirut' - 'Asia/Damascus' - 'Asia/Gaza' - 'Asia/Jerusalem' - 'Asia/Nicosia' - 'Europe/Athens' - 'Europe/Bucharest' - 'Europe/Chisinau' - 'Europe/Helsinki' - 'Europe/Istanbul' - 'Europe/Kaliningrad' - 'Europe/Kiev' - 'Europe/Riga' - 'Europe/Sofia' - 'Europe/Tallinn' - 'Europe/Vilnius' - 'Africa/Khartoum' - 'Africa/Nairobi' - 'Antarctica/Syowa' - 'Asia/Baghdad' - 'Asia/Qatar' - 'Asia/Riyadh' - 'Europe/Minsk' - 'Europe/Moscow' - 'Asia/Tehran' - 'Asia/Baku' - 'Asia/Dubai' - 'Asia/Tbilisi' - 'Asia/Yerevan' - 'Europe/Samara' - 'Indian/Mahe' - 'Indian/Mauritius' - 'Indian/Reunion' - 'Asia/Kabul' - 'Antarctica/Mawson' - 'Asia/Aqtau' - 'Asia/Aqtobe' - 'Asia/Ashgabat' - 'Asia/Dushanbe' - 'Asia/Karachi' - 'Asia/Tashkent' - 'Asia/Yekaterinburg' - 'Indian/Kerguelen' - 'Indian/Maldives' - 'Asia/Calcutta' - 'Asia/Kolkata' - 'Asia/Colombo' - 'Asia/Katmandu' - 'Antarctica/Vostok' - 'Asia/Almaty' - 'Asia/Bishkek' - 'Asia/Dhaka' - 'Asia/Omsk' - 'Asia/Thimphu' - 'Indian/Chagos' - 'Asia/Rangoon' - 'Indian/Cocos' - 'Antarctica/Davis' - 'Asia/Bangkok' - 'Asia/Hovd' - 'Asia/Jakarta' - 'Asia/Krasnoyarsk' - 'Asia/Saigon' - 'Indian/Christmas' - 'Antarctica/Casey' - 'Asia/Brunei' - 'Asia/Choibalsan' - 'Asia/Hong_Kong' - 'Asia/Irkutsk' - 'Asia/Kuala_Lumpur' - 'Asia/Macau' - 'Asia/Makassar' - 'Asia/Manila' - 'Asia/Shanghai' - 'Asia/Singapore' - 'Asia/Taipei' - 'Asia/Ulaanbaatar' - 'Australia/Perth' - 'Asia/Pyongyang' - 'Asia/Dili' - 'Asia/Jayapura' - 'Asia/Seoul' - 'Asia/Tokyo' - 'Asia/Yakutsk' - 'Pacific/Palau' - 'Australia/Adelaide' - 'Australia/Darwin' - 'Antarctica/DumontDUrville' - 'Asia/Magadan' - 'Asia/Vladivostok' - 'Australia/Brisbane' - 'Australia/Hobart' - 'Australia/Sydney' - 'Pacific/Chuuk' - 'Pacific/Guam' - 'Pacific/Port_Moresby' - 'Pacific/Efate' - 'Pacific/Guadalcanal' - 'Pacific/Kosrae' - 'Pacific/Norfolk' - 'Pacific/Noumea' - 'Pacific/Pohnpei' - 'Asia/Kamchatka' - 'Pacific/Auckland' - 'Pacific/Fiji' - 'Pacific/Funafuti' - 'Pacific/Kwajalein' - 'Pacific/Majuro' - 'Pacific/Nauru' - 'Pacific/Tarawa' - 'Pacific/Wake' - 'Pacific/Wallis' - 'Pacific/Apia' - 'Pacific/Enderbury' - 'Pacific/Fakaofo' - 'Pacific/Tongatapu' - 'Pacific/Kiritimati' default: Pacific/Niue x-omitempty: true ApplianceAccount: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true ntp.Policy.List: title: List of 'ntp.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ntp.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ntp.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/ntp.Policy' nullable: true onprem.ImagePackage: title: Onprem:Image Package description: |- ImagePackage encapsulates a software image package. ImagePackage can be a docker image, a UI web image, an endpoint (e.g. UCSM) image, a device connector image or an ansible scripts package. x-allOf-name: onprem.ImagePackage allOf: - # This 'onprem.ImagePackage' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'onprem.ImagePackage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'onprem.ImagePackage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'onprem.ImagePackage' ObjectType: enum: - 'onprem.ImagePackage' 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.Schedule: title: Onprem:Schedule description: |- Schedule is used by Intersight Appliance services to store task scheduling information. For example, appliance backup service uses Schedule to store the backup schedule of the Intersight Appliance. The Upgrade service uses Schedule to store the user-defined schedule for software upgrades of the Intersight Appliance. x-allOf-name: onprem.Schedule allOf: - # This 'onprem.Schedule' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'onprem.Schedule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'onprem.Schedule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'onprem.Schedule' ObjectType: enum: - 'onprem.Schedule' 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* `Pacific/Pago_Pago` - \n* `Pacific/Honolulu` - \n* `Pacific/Rarotonga` - \n* `Pacific/Tahiti` - \n* `Pacific/Marquesas` - \n* `America/Anchorage` - \n* `Pacific/Gambier` - \n* `America/Los_Angeles` - \n* `America/Tijuana` - \n* `America/Vancouver` - \n* `America/Whitehorse` - \n* `Pacific/Pitcairn` - \n* `America/Dawson_Creek` - \n* `America/Denver` - \n* `America/Edmonton` - \n* `America/Hermosillo` - \n* `America/Mazatlan` - \n* `America/Phoenix` - \n* `America/Yellowknife` - \n* `America/Belize` - \n* `America/Chicago` - \n* `America/Costa_Rica` - \n* `America/El_Salvador` - \n* `America/Guatemala` - \n* `America/Managua` - \n* `America/Mexico_City` - \n* `America/Regina` - \n* `America/Tegucigalpa` - \n* `America/Winnipeg` - \n* `Pacific/Galapagos` - \n* `America/Bogota` - \n* `America/Cancun` - \n* `America/Cayman` - \n* `America/Guayaquil` - \n* `America/Havana` - \n* `America/Iqaluit` - \n* `America/Jamaica` - \n* `America/Lima` - \n* `America/Nassau` - \n* `America/New_York` - \n* `America/Panama` - \n* `America/Port-au-Prince` - \n* `America/Rio_Branco` - \n* `America/Toronto` - \n* `Pacific/Easter` - \n* `America/Caracas` - \n* `America/Asuncion` - \n* `America/Barbados` - \n* `America/Boa_Vista` - \n* `America/Campo_Grande` - \n* `America/Cuiaba` - \n* `America/Curacao` - \n* `America/Grand_Turk` - \n* `America/Guyana` - \n* `America/Halifax` - \n* `America/La_Paz` - \n* `America/Manaus` - \n* `America/Martinique` - \n* `America/Port_of_Spain` - \n* `America/Porto_Velho` - \n* `America/Puerto_Rico` - \n* `America/Santo_Domingo` - \n* `America/Thule` - \n* `Atlantic/Bermuda` - \n* `America/St_Johns` - \n* `America/Araguaina` - \n* `America/Argentina/Buenos_Aires` - \n* `America/Bahia` - \n* `America/Belem` - \n* `America/Cayenne` - \n* `America/Fortaleza` - \n* `America/Godthab` - \n* `America/Maceio` - \n* `America/Miquelon` - \n* `America/Montevideo` - \n* `America/Paramaribo` - \n* `America/Recife` - \n* `America/Santiago` - \n* `America/Sao_Paulo` - \n* `Antarctica/Palmer` - \n* `Antarctica/Rothera` - \n* `Atlantic/Stanley` - \n* `America/Noronha` - \n* `Atlantic/South_Georgia` - \n* `America/Scoresbysund` - \n* `Atlantic/Azores` - \n* `Atlantic/Cape_Verde` - \n* `Africa/Abidjan` - \n* `Africa/Accra` - \n* `Africa/Bissau` - \n* `Africa/Casablanca` - \n* `Africa/El_Aaiun` - \n* `Africa/Monrovia` - \n* `America/Danmarkshavn` - \n* `Atlantic/Canary` - \n* `Atlantic/Faroe` - \n* `Atlantic/Reykjavik` - \n* `Etc/GMT` - \n* `Europe/Dublin` - \n* `Europe/Lisbon` - \n* `Europe/London` - \n* `Africa/Algiers` - \n* `Africa/Ceuta` - \n* `Africa/Lagos` - \n* `Africa/Ndjamena` - \n* `Africa/Tunis` - \n* `Africa/Windhoek` - \n* `Europe/Amsterdam` - \n* `Europe/Andorra` - \n* `Europe/Belgrade` - \n* `Europe/Berlin` - \n* `Europe/Brussels` - \n* `Europe/Budapest` - \n* `Europe/Copenhagen` - \n* `Europe/Gibraltar` - \n* `Europe/Luxembourg` - \n* `Europe/Madrid` - \n* `Europe/Malta` - \n* `Europe/Monaco` - \n* `Europe/Oslo` - \n* `Europe/Paris` - \n* `Europe/Prague` - \n* `Europe/Rome` - \n* `Europe/Stockholm` - \n* `Europe/Tirane` - \n* `Europe/Vienna` - \n* `Europe/Warsaw` - \n* `Europe/Zurich` - \n* `Africa/Cairo` - \n* `Africa/Johannesburg` - \n* `Africa/Maputo` - \n* `Africa/Tripoli` - \n* `Asia/Amman` - \n* `Asia/Beirut` - \n* `Asia/Damascus` - \n* `Asia/Gaza` - \n* `Asia/Jerusalem` - \n* `Asia/Nicosia` - \n* `Europe/Athens` - \n* `Europe/Bucharest` - \n* `Europe/Chisinau` - \n* `Europe/Helsinki` - \n* `Europe/Istanbul` - \n* `Europe/Kaliningrad` - \n* `Europe/Kiev` - \n* `Europe/Riga` - \n* `Europe/Sofia` - \n* `Europe/Tallinn` - \n* `Europe/Vilnius` - \n* `Africa/Khartoum` - \n* `Africa/Nairobi` - \n* `Antarctica/Syowa` - \n* `Asia/Baghdad` - \n* `Asia/Qatar` - \n* `Asia/Riyadh` - \n* `Europe/Minsk` - \n* `Europe/Moscow` - \n* `Asia/Tehran` - \n* `Asia/Baku` - \n* `Asia/Dubai` - \n* `Asia/Tbilisi` - \n* `Asia/Yerevan` - \n* `Europe/Samara` - \n* `Indian/Mahe` - \n* `Indian/Mauritius` - \n* `Indian/Reunion` - \n* `Asia/Kabul` - \n* `Antarctica/Mawson` - \n* `Asia/Aqtau` - \n* `Asia/Aqtobe` - \n* `Asia/Ashgabat` - \n* `Asia/Dushanbe` - \n* `Asia/Karachi` - \n* `Asia/Tashkent` - \n* `Asia/Yekaterinburg` - \n* `Indian/Kerguelen` - \n* `Indian/Maldives` - \n* `Asia/Calcutta` - \n* `Asia/Kolkata` - \n* `Asia/Colombo` - \n* `Asia/Katmandu` - \n* `Antarctica/Vostok` - \n* `Asia/Almaty` - \n* `Asia/Bishkek` - \n* `Asia/Dhaka` - \n* `Asia/Omsk` - \n* `Asia/Thimphu` - \n* `Indian/Chagos` - \n* `Asia/Rangoon` - \n* `Indian/Cocos` - \n* `Antarctica/Davis` - \n* `Asia/Bangkok` - \n* `Asia/Hovd` - \n* `Asia/Jakarta` - \n* `Asia/Krasnoyarsk` - \n* `Asia/Saigon` - \n* `Indian/Christmas` - \n* `Antarctica/Casey` - \n* `Asia/Brunei` - \n* `Asia/Choibalsan` - \n* `Asia/Hong_Kong` - \n* `Asia/Irkutsk` - \n* `Asia/Kuala_Lumpur` - \n* `Asia/Macau` - \n* `Asia/Makassar` - \n* `Asia/Manila` - \n* `Asia/Shanghai` - \n* `Asia/Singapore` - \n* `Asia/Taipei` - \n* `Asia/Ulaanbaatar` - \n* `Australia/Perth` - \n* `Asia/Pyongyang` - \n* `Asia/Dili` - \n* `Asia/Jayapura` - \n* `Asia/Seoul` - \n* `Asia/Tokyo` - \n* `Asia/Yakutsk` - \n* `Pacific/Palau` - \n* `Australia/Adelaide` - \n* `Australia/Darwin` - \n* `Antarctica/DumontDUrville` - \n* `Asia/Magadan` - \n* `Asia/Vladivostok` - \n* `Australia/Brisbane` - \n* `Australia/Hobart` - \n* `Australia/Sydney` - \n* `Pacific/Chuuk` - \n* `Pacific/Guam` - \n* `Pacific/Port_Moresby` - \n* `Pacific/Efate` - \n* `Pacific/Guadalcanal` - \n* `Pacific/Kosrae` - \n* `Pacific/Norfolk` - \n* `Pacific/Noumea` - \n* `Pacific/Pohnpei` - \n* `Asia/Kamchatka` - \n* `Pacific/Auckland` - \n* `Pacific/Fiji` - \n* `Pacific/Funafuti` - \n* `Pacific/Kwajalein` - \n* `Pacific/Majuro` - \n* `Pacific/Nauru` - \n* `Pacific/Tarawa` - \n* `Pacific/Wake` - \n* `Pacific/Wallis` - \n* `Pacific/Apia` - \n* `Pacific/Enderbury` - \n* `Pacific/Fakaofo` - \n* `Pacific/Tongatapu` - \n* `Pacific/Kiritimati` -" type: string enum: - 'Pacific/Niue' - 'Pacific/Pago_Pago' - 'Pacific/Honolulu' - 'Pacific/Rarotonga' - 'Pacific/Tahiti' - 'Pacific/Marquesas' - 'America/Anchorage' - 'Pacific/Gambier' - 'America/Los_Angeles' - 'America/Tijuana' - 'America/Vancouver' - 'America/Whitehorse' - 'Pacific/Pitcairn' - 'America/Dawson_Creek' - 'America/Denver' - 'America/Edmonton' - 'America/Hermosillo' - 'America/Mazatlan' - 'America/Phoenix' - 'America/Yellowknife' - 'America/Belize' - 'America/Chicago' - 'America/Costa_Rica' - 'America/El_Salvador' - 'America/Guatemala' - 'America/Managua' - 'America/Mexico_City' - 'America/Regina' - 'America/Tegucigalpa' - 'America/Winnipeg' - 'Pacific/Galapagos' - 'America/Bogota' - 'America/Cancun' - 'America/Cayman' - 'America/Guayaquil' - 'America/Havana' - 'America/Iqaluit' - 'America/Jamaica' - 'America/Lima' - 'America/Nassau' - 'America/New_York' - 'America/Panama' - 'America/Port-au-Prince' - 'America/Rio_Branco' - 'America/Toronto' - 'Pacific/Easter' - 'America/Caracas' - 'America/Asuncion' - 'America/Barbados' - 'America/Boa_Vista' - 'America/Campo_Grande' - 'America/Cuiaba' - 'America/Curacao' - 'America/Grand_Turk' - 'America/Guyana' - 'America/Halifax' - 'America/La_Paz' - 'America/Manaus' - 'America/Martinique' - 'America/Port_of_Spain' - 'America/Porto_Velho' - 'America/Puerto_Rico' - 'America/Santo_Domingo' - 'America/Thule' - 'Atlantic/Bermuda' - 'America/St_Johns' - 'America/Araguaina' - 'America/Argentina/Buenos_Aires' - 'America/Bahia' - 'America/Belem' - 'America/Cayenne' - 'America/Fortaleza' - 'America/Godthab' - 'America/Maceio' - 'America/Miquelon' - 'America/Montevideo' - 'America/Paramaribo' - 'America/Recife' - 'America/Santiago' - 'America/Sao_Paulo' - 'Antarctica/Palmer' - 'Antarctica/Rothera' - 'Atlantic/Stanley' - 'America/Noronha' - 'Atlantic/South_Georgia' - 'America/Scoresbysund' - 'Atlantic/Azores' - 'Atlantic/Cape_Verde' - 'Africa/Abidjan' - 'Africa/Accra' - 'Africa/Bissau' - 'Africa/Casablanca' - 'Africa/El_Aaiun' - 'Africa/Monrovia' - 'America/Danmarkshavn' - 'Atlantic/Canary' - 'Atlantic/Faroe' - 'Atlantic/Reykjavik' - 'Etc/GMT' - 'Europe/Dublin' - 'Europe/Lisbon' - 'Europe/London' - 'Africa/Algiers' - 'Africa/Ceuta' - 'Africa/Lagos' - 'Africa/Ndjamena' - 'Africa/Tunis' - 'Africa/Windhoek' - 'Europe/Amsterdam' - 'Europe/Andorra' - 'Europe/Belgrade' - 'Europe/Berlin' - 'Europe/Brussels' - 'Europe/Budapest' - 'Europe/Copenhagen' - 'Europe/Gibraltar' - 'Europe/Luxembourg' - 'Europe/Madrid' - 'Europe/Malta' - 'Europe/Monaco' - 'Europe/Oslo' - 'Europe/Paris' - 'Europe/Prague' - 'Europe/Rome' - 'Europe/Stockholm' - 'Europe/Tirane' - 'Europe/Vienna' - 'Europe/Warsaw' - 'Europe/Zurich' - 'Africa/Cairo' - 'Africa/Johannesburg' - 'Africa/Maputo' - 'Africa/Tripoli' - 'Asia/Amman' - 'Asia/Beirut' - 'Asia/Damascus' - 'Asia/Gaza' - 'Asia/Jerusalem' - 'Asia/Nicosia' - 'Europe/Athens' - 'Europe/Bucharest' - 'Europe/Chisinau' - 'Europe/Helsinki' - 'Europe/Istanbul' - 'Europe/Kaliningrad' - 'Europe/Kiev' - 'Europe/Riga' - 'Europe/Sofia' - 'Europe/Tallinn' - 'Europe/Vilnius' - 'Africa/Khartoum' - 'Africa/Nairobi' - 'Antarctica/Syowa' - 'Asia/Baghdad' - 'Asia/Qatar' - 'Asia/Riyadh' - 'Europe/Minsk' - 'Europe/Moscow' - 'Asia/Tehran' - 'Asia/Baku' - 'Asia/Dubai' - 'Asia/Tbilisi' - 'Asia/Yerevan' - 'Europe/Samara' - 'Indian/Mahe' - 'Indian/Mauritius' - 'Indian/Reunion' - 'Asia/Kabul' - 'Antarctica/Mawson' - 'Asia/Aqtau' - 'Asia/Aqtobe' - 'Asia/Ashgabat' - 'Asia/Dushanbe' - 'Asia/Karachi' - 'Asia/Tashkent' - 'Asia/Yekaterinburg' - 'Indian/Kerguelen' - 'Indian/Maldives' - 'Asia/Calcutta' - 'Asia/Kolkata' - 'Asia/Colombo' - 'Asia/Katmandu' - 'Antarctica/Vostok' - 'Asia/Almaty' - 'Asia/Bishkek' - 'Asia/Dhaka' - 'Asia/Omsk' - 'Asia/Thimphu' - 'Indian/Chagos' - 'Asia/Rangoon' - 'Indian/Cocos' - 'Antarctica/Davis' - 'Asia/Bangkok' - 'Asia/Hovd' - 'Asia/Jakarta' - 'Asia/Krasnoyarsk' - 'Asia/Saigon' - 'Indian/Christmas' - 'Antarctica/Casey' - 'Asia/Brunei' - 'Asia/Choibalsan' - 'Asia/Hong_Kong' - 'Asia/Irkutsk' - 'Asia/Kuala_Lumpur' - 'Asia/Macau' - 'Asia/Makassar' - 'Asia/Manila' - 'Asia/Shanghai' - 'Asia/Singapore' - 'Asia/Taipei' - 'Asia/Ulaanbaatar' - 'Australia/Perth' - 'Asia/Pyongyang' - 'Asia/Dili' - 'Asia/Jayapura' - 'Asia/Seoul' - 'Asia/Tokyo' - 'Asia/Yakutsk' - 'Pacific/Palau' - 'Australia/Adelaide' - 'Australia/Darwin' - 'Antarctica/DumontDUrville' - 'Asia/Magadan' - 'Asia/Vladivostok' - 'Australia/Brisbane' - 'Australia/Hobart' - 'Australia/Sydney' - 'Pacific/Chuuk' - 'Pacific/Guam' - 'Pacific/Port_Moresby' - 'Pacific/Efate' - 'Pacific/Guadalcanal' - 'Pacific/Kosrae' - 'Pacific/Norfolk' - 'Pacific/Noumea' - 'Pacific/Pohnpei' - 'Asia/Kamchatka' - 'Pacific/Auckland' - 'Pacific/Fiji' - 'Pacific/Funafuti' - 'Pacific/Kwajalein' - 'Pacific/Majuro' - 'Pacific/Nauru' - 'Pacific/Tarawa' - 'Pacific/Wake' - 'Pacific/Wallis' - 'Pacific/Apia' - 'Pacific/Enderbury' - 'Pacific/Fakaofo' - 'Pacific/Tongatapu' - 'Pacific/Kiritimati' 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.UpgradeNote: title: Onprem:Upgrade Note description: |- UpgradeNote managed object contains the description of one feature/bug fix. x-allOf-name: onprem.UpgradeNote allOf: - # This 'onprem.UpgradeNote' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'onprem.UpgradeNote' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'onprem.UpgradeNote', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'onprem.UpgradeNote' ObjectType: enum: - 'onprem.UpgradeNote' 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 process. This data structure is shared by both the Intersight upgrade service and the Intersight Appliance's upgrade service. x-allOf-name: onprem.UpgradePhase allOf: - # This 'onprem.UpgradePhase' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'onprem.UpgradePhase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'onprem.UpgradePhase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'onprem.UpgradePhase' ObjectType: enum: - 'onprem.UpgradePhase' 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. * `init` - Upgrade service initialization phase. * `Prepare` - Upgrade service prepares folders and templated files. * `ServiceLoad` - Upgrade service loads the service images into the local docker cache. * `UiLoad` - Upgrade service loads the UI packages into the local cache. * `GenerateConfig` - Upgrade service generates the Kubernetes configuration files. * `DeployService` - Upgrade service deploys the Kubernetes services. * `Success` - Upgrade completed successfully. * `Fail` - Indicates that the upgrade process has failed. * `Cancel` - Indicates that the upgrade was canceled by the Intersight Appliance. * `Telemetry` - Upgrade service sends basic telemetry data to the Intersight. type: string enum: - 'init' - 'Prepare' - 'ServiceLoad' - 'UiLoad' - 'GenerateConfig' - 'DeployService' - 'Success' - 'Fail' - 'Cancel' - 'Telemetry' default: init readOnly: true x-omitempty: true StartTime: description: |- Start date of the software upgrade phase. type: string format: date-time readOnly: true x-omitempty: true organization.Organization.Response: description: |- The response body of a HTTP GET request for the 'organization.Organization' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'organization.Organization' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'organization.Organization' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'organization.Organization', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'organization.Organization' ObjectType: enum: - 'organization.Organization' 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ResourceGroups: # A Relationship to MO resource.Group description: An array of relationships to resourceGroup resources. type: array items: $ref: '#/components/schemas/resource.Group.Relationship' nullable: 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. The '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 os.Answers: title: Os:Answers description: |- This MO captures the values for the most common set of fields in OS specific answer files. The values provided in this MO are used to construct the OS specific answer files (kickstart, seed, unattended xml) by replacing the fields/placeholders in selected os.ConfigurationFile content with the values of this MO properties. x-allOf-name: os.Answers allOf: - # This 'os.Answers' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'os.Answers' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.Answers', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.Answers' ObjectType: enum: - 'os.Answers' AnswerFile: description: |- If the source of the answers is a static file, the content of the file is stored as value in this property. The value is mandatory only when the 'Source' property has been set to 'File'. type: string writeOnly: true x-omitempty: true Hostname: description: |- Hostname to be configured for the server in the OS. type: string x-omitempty: true IpConfigType: description: |- IP configuration type. Values are Static or Dynamic configuration of IP. In case of static IP configuration, IP address, gateway and other details need to be populated. In case of dynamic the IP configuration is obtained dynamically from DHCP. * `static` - In case of static IP configuraton, provide the details such as IP address, netmask, and gateway. * `DHCP` - In case of dynamic IP configuration, the IP address, netmask and gateway detailsare obtained from DHCP. type: string enum: - 'static' - 'DHCP' default: static x-omitempty: true IpConfiguration: description: |- In case of static IP configuration, IP address, netmask and gateway details are provided. $ref: '#/components/schemas/os.IpConfiguration' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IsAnswerFileSet: description: |- Indicates whether the value of the 'answerFile' property has been set. type: boolean readOnly: true x-omitempty: true IsRootPasswordCrypted: description: |- Enable to indicate Root Password provided is encrypted. type: boolean x-omitempty: true IsRootPasswordSet: description: |- Indicates whether the value of the 'rootPassword' property has been set. type: boolean readOnly: true x-omitempty: true Nameserver: description: |- IP address of the name server to be configured in the OS. type: string x-omitempty: true ProductKey: description: |- The product key to be used for a specific version of Windows installation. type: string x-omitempty: true RootPassword: description: |- Password configured for the root / administrator user in the OS. You can enter a plain text or an encrypted password. Intersight encrypts the plaintext password. Enable the Encrypted Password option to provide an encrypted password. For more details on encrypting passwords, see Help Center. type: string writeOnly: true x-omitempty: true Source: description: "Answer values can be provided from three sources - Embedded in OS image, static file,\nor as placeholder values for an answer file template.\nSource of the answers is given as value, Embedded/File/Template.\n'Embedded' option indicates that the answer file is embedded within the OS Image. 'File'\noption indicates that the answers are provided as a file. 'Template' indicates that the\nplaceholders in the selected os.ConfigurationFile MO are replaced with values provided\nas os.Answers MO.\n* `None` - Indicates that answers is not sent and values must be populated from Install Template. \n* `Embedded` - Indicates that the answer file is embedded within OS image.\n* `File` - Indicates that the answer file is a static content that has all thevalues populated.\n* `Template` - Indicates that the given answers are used to populate the answer filetemplate. The template allows the users to refer some server specificanswers as fields/placeholders and replace these placeholders with theactual values for each Server during OS installation using 'Answers' and'AdditionalParameters' properties in os.Install MO.The answer file templates can be created by users as os.ConfigurationFile objects." type: string enum: - 'None' - 'Embedded' - 'File' - 'Template' default: None x-omitempty: true os.BaseInstallConfig: title: Base OS Install Configuration description: |- BaseInstallConfig models the configuration required to install OS. x-allOf-name: os.BaseInstallConfig allOf: - # This 'os.BaseInstallConfig' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'os.BaseInstallConfig' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.BaseInstallConfig', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: AdditionalParameters: type: array items: description: |- If the os.ConfigurationFile MO selected is a template that uses additional placeholders other than the ones provided in standard os.Answers MO, the values for those additional placeholders are provided here. $ref: '#/components/schemas/os.PlaceHolder' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Answers: description: |- Answers provided by user for the unattended OS installation. $ref: '#/components/schemas/os.Answers' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Description: description: |- User provided description about the OS install configuration. type: string x-omitempty: true InstallMethod: description: "The install method to be used for OS installation - vMedia, iPXE. \nOnly vMedia is supported as of now.\n* `vMedia` - OS image is mounted as vMedia in target server for OS installation." type: string enum: - 'vMedia' default: vMedia x-omitempty: true OperatingSystemParameters: description: |- Parameters specific to selected OS. $ref: '#/components/schemas/os.OperatingSystemParameters' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true os.Catalog.Response: description: |- The response body of a HTTP GET request for the 'os.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'os.Catalog' resources. x-one-of-name: os.Catalog.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/os.Catalog.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType os.Catalog.Relationship: description: A relationship to the 'os.Catalog' resource, or the expanded 'os.Catalog' resource, or the 'null' value. x-one-of-name: os.Catalog.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/os.Catalog' os.Catalog: title: Os:Catalog description: |- A catalog of operating systems related objects such as configuration files and post install scripts. Each user account will have a local OS catalog where account users can store their private configuration files and post install scripts. Cisco provides validated answer files and post install scripts to Intersight users via shared catalogs. Intersight users will be able to read, use these files and scripts in OS installation within their account context. The shared catalogs will be managed entirely by Cisco. Contributions to shared catalogs will need to be provided to Cisco who will publish them at their own discretion. x-allOf-name: os.Catalog allOf: - # This 'os.Catalog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'os.Catalog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.Catalog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.Catalog' ObjectType: enum: - 'os.Catalog' Name: description: |- The catalog name. There will be one for system and one for each user account. type: string x-omitempty: true ConfigurationFiles: # A Relationship to MO os.ConfigurationFile description: An array of relationships to osConfigurationFile resources. type: array items: $ref: '#/components/schemas/os.ConfigurationFile.Relationship' nullable: true Distributions: # A Relationship to MO os.Distribution description: An array of relationships to osDistribution resources. type: array items: $ref: '#/components/schemas/os.Distribution.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true os.Catalog.List: title: List of 'os.Catalog' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'os.Catalog' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'os.Catalog' resources matching the request. type: array items: $ref: '#/components/schemas/os.Catalog' nullable: true os.ConfigurationFile.Response: description: |- The response body of a HTTP GET request for the 'os.ConfigurationFile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'os.ConfigurationFile' resources. x-one-of-name: os.ConfigurationFile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/os.ConfigurationFile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType os.ConfigurationFile.Relationship: description: A relationship to the 'os.ConfigurationFile' resource, or the expanded 'os.ConfigurationFile' resource, or the 'null' value. x-one-of-name: os.ConfigurationFile.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/os.ConfigurationFile' os.ConfigurationFile: title: Os:Configuration File description: |- A ConfigurationFile is an OS specific answer file that helps with the unattended installation. The file can also be a template file with placeholders instead of actual answers. Intersight supports the golang template syntax specified in https://golang.org/pkg/text/template/. The template supports placeholders for all the properties of os.Answers MO type as well as any additional user-defined properties. The values for these placeholders shall be given during OS installation in the form of os.Answers type and 'additionalProperties' in os.OsInstall object. x-allOf-name: os.ConfigurationFile allOf: - # This 'os.ConfigurationFile' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'os.ConfigurationFile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.ConfigurationFile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.ConfigurationFile' ObjectType: enum: - 'os.ConfigurationFile' FileContent: description: |- The content of the entire configuration file is stored as value. The content can either be a static file content or a template content. The template is expected to conform to the golang template syntax. The values from os.Answers properties will be used to populate this template. type: string x-omitempty: true Name: description: |- The name of the OS ConfigurationFile that uniquely identifies the configuration file. type: string pattern: "^[a-zA-Z0-9\\._\\-]+$" maxLength: 64 x-createOnly: true x-omitempty: true Placeholders: type: array items: description: |- This readonly property holds the list of placeholder names used in the configuration file content in case it is a template. $ref: '#/components/schemas/os.PlaceHolder' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Supported: description: |- An internal property that is used to distinguish between the pre-canned OS configuration file entries and user provided entries. type: boolean readOnly: true x-omitempty: true Catalog: # A Relationship to MO os.Catalog $ref: '#/components/schemas/os.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a osCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. Distributions: # A Relationship to MO hcl.OperatingSystem description: An array of relationships to hclOperatingSystem resources. type: array items: $ref: '#/components/schemas/hcl.OperatingSystem.Relationship' nullable: true os.ConfigurationFile.List: title: List of 'os.ConfigurationFile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'os.ConfigurationFile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'os.ConfigurationFile' resources matching the request. type: array items: $ref: '#/components/schemas/os.ConfigurationFile' nullable: true os.Distribution.Response: description: |- The response body of a HTTP GET request for the 'os.Distribution' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'os.Distribution' resources. x-one-of-name: os.Distribution.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/os.Distribution.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType os.Distribution.Relationship: description: A relationship to the 'os.Distribution' resource, or the expanded 'os.Distribution' resource, or the 'null' value. x-one-of-name: os.Distribution.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/os.Distribution' os.Distribution: title: Os:Distribution description: |- Intersight has the distribution details for all the Intersight supported OS distributions. There will be a Distribution object for each supported OS. x-allOf-name: os.Distribution allOf: - # This 'os.Distribution' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'os.Distribution' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.Distribution', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.Distribution' ObjectType: enum: - 'os.Distribution' Name: description: |- The name of the OS distribution such as ESXi, CentOS. type: string x-createOnly: true x-omitempty: true SupportedEditions: type: array items: description: |- A Collection of all the Editions of the OS Distribution that is supported within Intersight. Editions available with OS Vendor but not available in this list are not supported for OS Installation through Intersight. type: string readOnly: true x-omitempty: true Catalog: # A Relationship to MO os.Catalog $ref: '#/components/schemas/os.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a osCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. Version: # A Relationship to MO hcl.OperatingSystem $ref: '#/components/schemas/hcl.OperatingSystem.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hclOperatingSystem resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true os.Distribution.List: title: List of 'os.Distribution' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'os.Distribution' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'os.Distribution' resources matching the request. type: array items: $ref: '#/components/schemas/os.Distribution' nullable: true os.Install.Response: description: |- The response body of a HTTP GET request for the 'os.Install' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'os.Install' resources. x-one-of-name: os.Install.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/os.Install.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType os.Install: title: OS Install description: |- This MO models the target server, answers and other properties needed for OS installation. The OS installation can be started in the target server by doing a POST on this MO. The requests to this MO starts a OS installation workflow that can be tracked using workflow engine MO workflow.WorkflowInfo. x-allOf-name: os.Install allOf: - # This 'os.Install' class inherits all properties from its parent class os.BaseInstallConfig. $ref: '#/components/schemas/os.BaseInstallConfig' - # The definition of all the properties specified in this 'os.Install' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.Install', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.Install' ObjectType: enum: - 'os.Install' Name: description: |- The name of the OS install configuration. type: string x-createOnly: true x-omitempty: true ConfigurationFile: # A Relationship to MO os.ConfigurationFile $ref: '#/components/schemas/os.ConfigurationFile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a osConfigurationFile resource. When the $expand query parameter is specified, the referenced resource is returned inline. Image: # A Relationship to MO softwarerepository.OperatingSystemFile $ref: '#/components/schemas/softwarerepository.OperatingSystemFile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryOperatingSystemFile resource. When the $expand query parameter is specified, the referenced resource is returned inline. Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true OsduImage: # A Relationship to MO firmware.ServerConfigurationUtilityDistributable $ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a firmwareServerConfigurationUtilityDistributable resource. When the $expand query parameter is specified, the referenced resource is returned inline. Server: # A Relationship to MO compute.Physical $ref: '#/components/schemas/compute.Physical.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computePhysical resource. When the $expand query parameter is specified, the referenced resource is returned inline. WorkflowInfo: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. os.Install.List: title: List of 'os.Install' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'os.Install' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'os.Install' resources matching the request. type: array items: $ref: '#/components/schemas/os.Install' nullable: true os.IpConfiguration: title: Os:Ip Configuration description: |- The IP configuration used to configure Static IPv4/IPv6 configurations. x-allOf-name: os.IpConfiguration allOf: - # This 'os.IpConfiguration' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' os.Ipv4Configuration: title: IPv4 Configuration description: |- In case of static IPv4 configuration, IP address, netmask and gateway details are provided. x-allOf-name: os.Ipv4Configuration allOf: - # This 'os.Ipv4Configuration' class inherits all properties from its parent class os.IpConfiguration. $ref: '#/components/schemas/os.IpConfiguration' - # The definition of all the properties specified in this 'os.Ipv4Configuration' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.Ipv4Configuration', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.Ipv4Configuration' ObjectType: enum: - 'os.Ipv4Configuration' IpV4Config: description: |- In case of static IP configuration, IP address, netmask and gateway details are provided. $ref: '#/components/schemas/comm.IpV4Interface' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true os.Ipv6Configuration: title: IPv6 Configuration description: |- In case of static IPv6 configuration, IP address, netmask and gateway details are provided. x-allOf-name: os.Ipv6Configuration allOf: - # This 'os.Ipv6Configuration' class inherits all properties from its parent class os.IpConfiguration. $ref: '#/components/schemas/os.IpConfiguration' - # The definition of all the properties specified in this 'os.Ipv6Configuration' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.Ipv6Configuration', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.Ipv6Configuration' ObjectType: enum: - 'os.Ipv6Configuration' IpV6Config: description: |- In case of static IP configuration, IP address, netmask and gateway details are provided. $ref: '#/components/schemas/comm.IpV6Interface' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true os.OperatingSystemParameters: title: Os:Operating System Parameters description: |- Installation parameters specific to selected OS. x-allOf-name: os.OperatingSystemParameters allOf: - # This 'os.OperatingSystemParameters' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' os.OsSupport: title: Os:Os Support description: |- OsSupport is used to validate the support for an Operating System's version. x-allOf-name: os.OsSupport allOf: - # This 'os.OsSupport' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'os.OsSupport' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.OsSupport', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.OsSupport' ObjectType: enum: - 'os.OsSupport' OsVersion: description: |- The version of the Operating System to be validated. The version should be as per HCL. type: string x-createOnly: true x-omitempty: true os.PlaceHolder: title: Os:Place Holder description: |- Definition for place holders in templates/post install scripts. x-allOf-name: os.PlaceHolder allOf: - # This 'os.PlaceHolder' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'os.PlaceHolder' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.PlaceHolder', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.PlaceHolder' ObjectType: enum: - 'os.PlaceHolder' IsValueSet: description: |- Flag to indicate if value is set. Value will be used to check if any edit. type: boolean x-omitempty: true Type: description: |- Definition of place holder. $ref: '#/components/schemas/workflow.PrimitiveDataType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Value: description: |- Value for placeholder provided by user. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true os.TemplateFile: title: Os:Template File description: |- A TemplateFile is an OS specific answer file that helps with the unattended installation. The file can also be a template file with placeholders instead of actual answers. Intersight supports the golang template syntax specified in https://golang.org/pkg/text/template/. The values for these placeholders shall be given during OS installation in the form of 'additionalProperties' in os.OsInstall object. x-allOf-name: os.TemplateFile allOf: - # This 'os.TemplateFile' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'os.TemplateFile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.TemplateFile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.TemplateFile' ObjectType: enum: - 'os.TemplateFile' Name: description: |- The name of the OS Template File that user uploads for unattended installation. type: string x-createOnly: true x-omitempty: true Placeholders: type: array items: description: |- This readonly property holds the list of placeholder names used in the template file content. type: string readOnly: true x-omitempty: true TemplateContent: description: "The content of the entire template file is stored as value. The content\ncan either be a static file content or a template content.\nThe template is expected to conform to the golang template syntax. \nThe placeholders, if any, would be populated and the values provided would be \nused to populate this template." type: string x-omitempty: true os.WindowsParameters: title: Windows Parameters description: |- This stores the installation parameters specific to Windows . x-allOf-name: os.WindowsParameters allOf: - # This 'os.WindowsParameters' class inherits all properties from its parent class os.OperatingSystemParameters. $ref: '#/components/schemas/os.OperatingSystemParameters' - # The definition of all the properties specified in this 'os.WindowsParameters' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'os.WindowsParameters', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'os.WindowsParameters' ObjectType: enum: - 'os.WindowsParameters' Edition: description: |- Lists all the editions supported for Windows Server installation. * `Standard` - Windows Standard Edition ideal for advanced features with limited virtualization. * `StandardCore` - Windows Standard Core Edition is a minimal installation option while installing Standard Core that is ideal for advanced features with limited virtualization. * `Datacenter` - Windows Standard Core Edition ideal for high requirements on IT workloads with largenumber fo virtual systems. * `DatacenterCore` - Windows Datacenter Core Edition is a minimal installation option while installing Datacenter Core that isideal for high requirements on IT workloads with largenumber for virtual systems. * `Core` - Microsoft Hyper-V is a native hypervisor to create and run virtual machines. type: string enum: - 'Standard' - 'StandardCore' - 'Datacenter' - 'DatacenterCore' - 'Core' default: Standard x-omitempty: true pci.CoprocessorCard.Response: description: |- The response body of a HTTP GET request for the 'pci.CoprocessorCard' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'pci.CoprocessorCard' resources. x-one-of-name: pci.CoprocessorCard.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/pci.CoprocessorCard.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType pci.CoprocessorCard.Relationship: description: A relationship to the 'pci.CoprocessorCard' resource, or the expanded 'pci.CoprocessorCard' resource, or the 'null' value. x-one-of-name: pci.CoprocessorCard.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/pci.CoprocessorCard' pci.CoprocessorCard: title: Pci:Coprocessor Card description: |- PCIe Compression and Cryptographic CPU Offload Card. x-allOf-name: pci.CoprocessorCard allOf: - # This 'pci.CoprocessorCard' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'pci.CoprocessorCard' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pci.CoprocessorCard', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pci.CoprocessorCard' ObjectType: enum: - 'pci.CoprocessorCard' CardId: description: |- The id of the coprocessor card. type: integer format: int64 readOnly: true x-omitempty: true PciSlot: description: |- The PCI slot name for the coprocessor card. type: string readOnly: true x-omitempty: true ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true pci.CoprocessorCard.List: title: List of 'pci.CoprocessorCard' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'pci.CoprocessorCard' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'pci.CoprocessorCard' resources matching the request. type: array items: $ref: '#/components/schemas/pci.CoprocessorCard' nullable: true pci.Device.Response: description: |- The response body of a HTTP GET request for the 'pci.Device' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'pci.Device' resources. x-one-of-name: pci.Device.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/pci.Device.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType pci.Device.Relationship: description: A relationship to the 'pci.Device' resource, or the expanded 'pci.Device' resource, or the 'null' value. x-one-of-name: pci.Device.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/pci.Device' pci.Device: title: Pci:Device description: |- PCI device present in a server. x-allOf-name: pci.Device allOf: - # This 'pci.Device' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'pci.Device' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pci.Device', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pci.Device' ObjectType: enum: - 'pci.Device' FirmwareVersion: description: |- The running firmware version of the PCI device. type: string x-omitempty: true Pid: description: |- The product identifier of the PCI device. type: string x-omitempty: true SlotId: description: |- The PCI slot id of the PCI device. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true pci.Device.List: title: List of 'pci.Device' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'pci.Device' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'pci.Device' resources matching the request. type: array items: $ref: '#/components/schemas/pci.Device' nullable: true pci.Link.Response: description: |- The response body of a HTTP GET request for the 'pci.Link' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'pci.Link' resources. x-one-of-name: pci.Link.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/pci.Link.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType pci.Link.Relationship: description: A relationship to the 'pci.Link' resource, or the expanded 'pci.Link' resource, or the 'null' value. x-one-of-name: pci.Link.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/pci.Link' pci.Link: title: Pci:Link description: |- The PCI Switch Link connected to PCIe Switch. x-allOf-name: pci.Link allOf: - # This 'pci.Link' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'pci.Link' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pci.Link', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pci.Link' ObjectType: enum: - 'pci.Link' Adapter: description: |- The name of the PCI device. type: string readOnly: true x-omitempty: true LinkSpeed: description: |- The upstream link speed of the PCI device. type: string readOnly: true x-omitempty: true LinkStatus: description: |- The upstream link status of the PCI device. type: string readOnly: true x-omitempty: true LinkWidth: description: |- The upstream link width of the PCI device. type: string readOnly: true x-omitempty: true PciSlot: description: |- The slot name of the PCI device. type: string readOnly: true x-omitempty: true SlotStatus: description: |- The health information of the PCI device. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PciSwitch: # A Relationship to MO pci.Switch $ref: '#/components/schemas/pci.Switch.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a pciSwitch resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true pci.Link.List: title: List of 'pci.Link' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'pci.Link' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'pci.Link' resources matching the request. type: array items: $ref: '#/components/schemas/pci.Link' nullable: true pci.Switch.Response: description: |- The response body of a HTTP GET request for the 'pci.Switch' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'pci.Switch' resources. x-one-of-name: pci.Switch.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/pci.Switch.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType pci.Switch.Relationship: description: A relationship to the 'pci.Switch' resource, or the expanded 'pci.Switch' resource, or the 'null' value. x-one-of-name: pci.Switch.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/pci.Switch' pci.Switch: title: Pci:Switch description: |- PCI Switch present in a server connected to two GPUs and one PCIe adapter. x-allOf-name: pci.Switch allOf: - # This 'pci.Switch' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'pci.Switch' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pci.Switch', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pci.Switch' ObjectType: enum: - 'pci.Switch' DeviceId: description: |- The device id of the switch. type: string readOnly: true x-omitempty: true Health: description: |- The composite health of the switch. type: string readOnly: true x-omitempty: true NumOfAdaptors: description: |- The number of GPUs and PCI adapters connected the switch. type: string readOnly: true x-omitempty: true PciAddress: description: |- The PCI address of the switch. type: string readOnly: true x-omitempty: true PciSlot: description: |- The PCI slot name of the switch. type: string readOnly: true x-omitempty: true ProductName: description: |- The model information for the switch. type: string readOnly: true x-omitempty: true ProductRevision: description: |- The product revision of the switch. type: string readOnly: true x-omitempty: true SubDeviceId: description: |- The sub device id of the switch. type: string readOnly: true x-omitempty: true SubVendorId: description: |- The sub vendor id of the switch. type: string readOnly: true x-omitempty: true Temperature: description: |- The current temperature of the switch. type: string readOnly: true x-omitempty: true Type: description: |- The type information of the switch. type: string x-omitempty: true VendorId: description: |- The vendor id of the switch. type: string readOnly: true x-omitempty: true ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Links: # A Relationship to MO pci.Link description: An array of relationships to pciLink resources. type: array items: $ref: '#/components/schemas/pci.Link.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningFirmware: # A Relationship to MO firmware.RunningFirmware description: An array of relationships to firmwareRunningFirmware resources. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' nullable: true readOnly: true pci.Switch.List: title: List of 'pci.Switch' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'pci.Switch' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'pci.Switch' resources matching the request. type: array items: $ref: '#/components/schemas/pci.Switch' nullable: true 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 allOf: - # This 'pkix.DistinguishedName' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'pkix.DistinguishedName' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pkix.DistinguishedName', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pkix.DistinguishedName' ObjectType: enum: - 'pkix.DistinguishedName' 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 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 Organization: type: array items: description: |- Identifier for the organization in which the entity resides. type: string readOnly: true x-omitempty: true OrganizationalUnit: type: array items: description: |- Identifier for a unit within the organization. type: string readOnly: true x-omitempty: true State: type: array items: description: |- Identifier for the state or province of the entity. type: string readOnly: true x-omitempty: 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. The ECDSA standard was originally developed for the American National Standards Institute by the Accredited Standards Committee on Financial Services, X9. ANS X9.62 defines methods for digital signature generation and verification using ECDSA. Specifications for the generation of the domain parameters used during the generation and verification of digital signatures are also included in ANS X9.62. x-allOf-name: pkix.EcdsaKeySpec allOf: - # This 'pkix.EcdsaKeySpec' class inherits all properties from its parent class pkix.KeyGenerationSpec. $ref: '#/components/schemas/pkix.KeyGenerationSpec' - # The definition of all the properties specified in this 'pkix.EcdsaKeySpec' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pkix.EcdsaKeySpec', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pkix.EcdsaKeySpec' ObjectType: enum: - 'pkix.EcdsaKeySpec' Curve: description: |- A specific set of Elliptic Curve parameters, as recommended by NIST in FIPS 186-4. * `P256` - P256 returns a Curve which implements P-256, as defined in FIPS 186-4, section D.2.3. * `P224` - P224 returns a Curve which implements P-224, as defined in FIPS 186-4, section D.2.2. * `P384` - P384 returns a Curve which implements P-384, as defined in FIPS 186-4, section D.2.4. * `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). The Edwards-curve Digital Signature Algorithm (EdDSA) is a variant of Schnorr's signature system with (possibly twisted) Edwards curves. x-allOf-name: pkix.EddsaKeySpec allOf: - # This 'pkix.EddsaKeySpec' class inherits all properties from its parent class pkix.KeyGenerationSpec. $ref: '#/components/schemas/pkix.KeyGenerationSpec' - # The definition of all the properties specified in this 'pkix.EddsaKeySpec' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pkix.EddsaKeySpec', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pkix.EddsaKeySpec' ObjectType: enum: - 'pkix.EddsaKeySpec' Algorithm: description: |- The EdDSA algorithm, as defined in RFC 8032. * `Ed25519` - The edwards25519 curve, as defined in RFC 8032 section 5.1. * `Ed25519ph` - The edwards25519 curve for the PureEdDSA variant. * `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 allOf: - # This 'pkix.KeyGenerationSpec' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'pkix.KeyGenerationSpec' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pkix.KeyGenerationSpec', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- Name of the key generation algorithm. * `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: - # This 'pkix.RsaAlgorithm' class inherits all properties from its parent class pkix.KeyGenerationSpec. $ref: '#/components/schemas/pkix.KeyGenerationSpec' - # The definition of all the properties specified in this 'pkix.RsaAlgorithm' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pkix.RsaAlgorithm', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pkix.RsaAlgorithm' ObjectType: enum: - 'pkix.RsaAlgorithm' Modulus: description: |- The length of the RSA key, expressed in bits, for both public and private keys. * `2048` - A key length of 2048 bits. * `2560` - A key length of 2560 bits. * `3072` - A key length of 3072 bits. * `3584` - A key length of 3584 bits. * `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 allOf: - # This 'pkix.SubjectAlternateName' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'pkix.SubjectAlternateName' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pkix.SubjectAlternateName', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'pkix.SubjectAlternateName' ObjectType: enum: - 'pkix.SubjectAlternateName' DnsName: type: array items: description: |- Alternate DNS names for the host. type: string readOnly: true x-omitempty: true EmailAddress: type: array items: description: |- Alternate email addresses for the host. type: string readOnly: true x-omitempty: true IpAddress: type: array items: description: |- Alternate IP addresses for the host. type: string readOnly: true x-omitempty: true Uri: type: array items: description: |- Alternate URIs for the host. type: string readOnly: true x-omitempty: 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: - # This 'policy.AbstractConfigChangeDetail' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'policy.AbstractConfigChangeDetail' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.AbstractConfigChangeDetail', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Changes: type: array items: description: |- Type of the configuration change. type: string x-omitempty: true ConfigChangeContext: description: |- Context information on the change. $ref: '#/components/schemas/policy.ConfigResultContext' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ConfigChangeFlag: description: |- Config change flag to differentiate Pending-changes and Config-drift. * `Pending-changes` - Config change flag represents changes are due to not deployed changes from Intersight. * `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 Message: description: |- Detailed description of the config change. type: string x-omitempty: true ModStatus: description: |- Modification status of the mo in this config change. * `None` - The 'none' operation/state.Indicates a configuration profile has been deployed, and the desired configuration matches the actual device configuration. * `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. * `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 succesfully. * `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' 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: - # This 'policy.AbstractConfigProfile' class inherits all properties from its parent class policy.AbstractProfile. $ref: '#/components/schemas/policy.AbstractProfile' - # The definition of all the properties specified in this 'policy.AbstractConfigProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.AbstractConfigProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: 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 x-omitempty: true ConfigContext: description: |- The configuration state and results of the last configuration operation. $ref: '#/components/schemas/policy.ConfigContext' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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: - # This 'policy.AbstractConfigResult' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'policy.AbstractConfigResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.AbstractConfigResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ConfigStage: description: |- The current running stage of the configuration or workflow. type: string 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 x-omitempty: true ValidationState: description: |- Indicates overall state for logical model validation. Values -- Ok, Ok-with-warning, Errored. type: string x-omitempty: true policy.AbstractConfigResultEntry: title: Policy:Abstract Config Result Entry description: |- The results details information. x-allOf-name: policy.AbstractConfigResultEntry allOf: - # This 'policy.AbstractConfigResultEntry' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'policy.AbstractConfigResultEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.AbstractConfigResultEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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. The owner ID is used to correlate a given result entry to a task or entity. For example, a config result entry 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.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: - # This 'policy.AbstractPolicy' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'policy.AbstractPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.AbstractPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Description of the policy. type: string pattern: "^$|^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]*$" 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.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' policy.AbstractProfile: title: Policy:Abstract Profile description: |- Abstract base type for all profiles. x-allOf-name: policy.AbstractProfile allOf: - # This 'policy.AbstractProfile' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'policy.AbstractProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.AbstractProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Description of the profile. type: string pattern: "^$|^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]*$" maxLength: 1024 x-omitempty: true Name: description: |- Name of the concrete profile. type: string pattern: "^[a-zA-Z0-9_.-]{1,64}$" x-omitempty: true Type: description: |- Defines the type of the profile. Accepted value is instance. * `instance` - The profile defines the configuration for a specific instance of a target. type: string enum: - 'instance' default: instance x-omitempty: true SrcTemplate: # A Relationship to MO policy.AbstractProfile $ref: '#/components/schemas/policy.AbstractProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a policyAbstractProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. 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 allOf: - # This 'policy.ConfigChange' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'policy.ConfigChange' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.ConfigChange', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'policy.ConfigChange' ObjectType: enum: - 'policy.ConfigChange' Changes: type: array items: description: |- Configuration changes at summary level. type: string x-omitempty: true Disruptions: type: array items: description: |- Configuration disruptions. type: string x-omitempty: true policy.ConfigContext: title: Policy:Config Context description: |- Configuration related state and results. x-allOf-name: policy.ConfigContext allOf: - # This 'policy.ConfigContext' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'policy.ConfigContext' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.ConfigContext', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'policy.ConfigContext' ObjectType: enum: - 'policy.ConfigContext' ConfigState: description: |- Indicates a profile's configuration deploying state. Values -- Assigned, Not-assigned, Associated, Pending-changes, Validating, Configuring, Failed. 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 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 allOf: - # This 'policy.ConfigResultContext' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'policy.ConfigResultContext' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policy.ConfigResultContext', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'policy.ConfigResultContext' ObjectType: enum: - 'policy.ConfigResultContext' EntityData: description: |- The data of the object present in config result context. # Property is any value, it may be the null value, an object or array. nullable: 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 policyinventory.AbstractDeviceInfo: title: Policyinventory:Abstract Device Info description: |- Information pertaining to a Registered Device in Intersight which is pertinent to policy microservice. x-allOf-name: policyinventory.AbstractDeviceInfo allOf: - # This 'policyinventory.AbstractDeviceInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'policyinventory.AbstractDeviceInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policyinventory.AbstractDeviceInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ConfigState: description: |- Configuration state of server profile config context. type: string readOnly: true x-omitempty: true ControlAction: description: |- Control action of server profile config context. type: string readOnly: true x-omitempty: true ErrorState: description: |- Error state of server profile config context. type: string readOnly: true x-omitempty: true JobInfo: type: array items: description: |- Inventory job information of the device. $ref: '#/components/schemas/policyinventory.JobInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true OperState: description: |- Operational state of server profile config context. type: string readOnly: true x-omitempty: true ProfileMoId: description: |- Server profile MO ID of the server. type: string readOnly: true x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true policyinventory.JobInfo: title: Policyinventory:Job Info description: |- Complex type representing the Job Information of a device. x-allOf-name: policyinventory.JobInfo allOf: - # This 'policyinventory.JobInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'policyinventory.JobInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'policyinventory.JobInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'policyinventory.JobInfo' ObjectType: enum: - 'policyinventory.JobInfo' ExecutionStatus: description: |- Execution status of the inventory job. * `Scheduled` - Inventory job is marked as scheduled. * `Completed` - Inventory job is marked as completed. * `Error` - Inventory job has errored out. type: string enum: - 'Scheduled' - 'Completed' - 'Error' default: Scheduled readOnly: true x-omitempty: true LastScheduledTime: description: |- Last scheduled time of the inventory job. type: string format: date-time readOnly: true x-omitempty: true PolicyId: description: |- Policy ID for the inventory job. type: string readOnly: true x-omitempty: true PolicyName: description: |- Policy name for the inventory job. type: string readOnly: true x-omitempty: true pool.AbstractBlock: title: Pool:Abstract Block description: |- Abstract base counters for a block of identifiers. x-allOf-name: pool.AbstractBlock allOf: - # This 'pool.AbstractBlock' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'pool.AbstractBlock' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pool.AbstractBlock', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: 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 pool.AbstractBlockType: title: Pool:Abstract Block Type description: |- Abstract base class for a block of identifiers. x-allOf-name: pool.AbstractBlockType allOf: - # This 'pool.AbstractBlockType' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'pool.AbstractBlockType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pool.AbstractBlockType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Size: description: |- Number of identifiers this block can hold. type: integer format: int64 minimum: 1 maximum: 1000 readOnly: 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: - # This 'pool.AbstractPool' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'pool.AbstractPool' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pool.AbstractPool', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Assigned: description: |- Number of IDs that are currently assigned. type: integer format: int64 readOnly: true x-omitempty: true AssignmentOrder: description: |- Assignment order decides the order in which the next identifier is allocated. * `sequential` - Identifiers are assigned in a sequential order. * `default` - Assignment order is decided by the system. type: string enum: - 'sequential' - 'default' default: sequential 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: |- PoolMember represents a single identifier that is part of a pool. x-allOf-name: pool.AbstractPoolMember allOf: - # This 'pool.AbstractPoolMember' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'pool.AbstractPoolMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'pool.AbstractPoolMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Assigned: description: |- Boolean to represent whether the ID is assigned or not. type: boolean x-omitempty: true port.Group.Response: description: |- The response body of a HTTP GET request for the 'port.Group' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'port.Group' resources. x-one-of-name: port.Group.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/port.Group.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType port.Group.Relationship: description: A relationship to the 'port.Group' resource, or the expanded 'port.Group' resource, or the 'null' value. x-one-of-name: port.Group.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/port.Group' port.Group: title: Port:Group description: |- Holder for multiple ports. A switch card will have one or more port groups. x-allOf-name: port.Group allOf: - # This 'port.Group' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'port.Group' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'port.Group', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'port.Group' ObjectType: enum: - 'port.Group' Transport: description: |- Type of port group. Values are Eth or Fc. type: string readOnly: true x-omitempty: true EquipmentSharedIoModule: # A Relationship to MO equipment.SharedIoModule $ref: '#/components/schemas/equipment.SharedIoModule.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSharedIoModule resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentSwitchCard: # A Relationship to MO equipment.SwitchCard $ref: '#/components/schemas/equipment.SwitchCard.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentSwitchCard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EthernetPorts: # A Relationship to MO ether.PhysicalPort description: An array of relationships to etherPhysicalPort resources. type: array items: $ref: '#/components/schemas/ether.PhysicalPort.Relationship' nullable: true readOnly: true FcPorts: # A Relationship to MO fc.PhysicalPort description: An array of relationships to fcPhysicalPort resources. type: array items: $ref: '#/components/schemas/fc.PhysicalPort.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true SubGroups: # A Relationship to MO port.SubGroup description: An array of relationships to portSubGroup resources. type: array items: $ref: '#/components/schemas/port.SubGroup.Relationship' nullable: true readOnly: true port.Group.List: title: List of 'port.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 'port.Group' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'port.Group' resources matching the request. type: array items: $ref: '#/components/schemas/port.Group' nullable: true port.InterfaceBase.Relationship: description: A relationship to the 'port.InterfaceBase' resource, or the expanded 'port.InterfaceBase' resource, or the 'null' value. x-one-of-name: port.InterfaceBase.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/port.InterfaceBase' port.InterfaceBase: title: Port:Interface Base description: |- Abstract Interface Base class for a virtual interface card/Fex Network Port. x-allOf-name: port.InterfaceBase allOf: - # This 'port.InterfaceBase' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'port.InterfaceBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'port.InterfaceBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: OperState: description: |- Operational state of an Interface. type: string x-omitempty: true AcknowledgedPeerInterface: # A Relationship to MO ether.PhysicalPortBase $ref: '#/components/schemas/ether.PhysicalPortBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a etherPhysicalPortBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. PeerInterface: # A Relationship to MO ether.PhysicalPortBase $ref: '#/components/schemas/ether.PhysicalPortBase.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a etherPhysicalPortBase resource. When the $expand query parameter is specified, the referenced resource is returned inline. port.MacBinding.Response: description: |- The response body of a HTTP GET request for the 'port.MacBinding' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'port.MacBinding' resources. x-one-of-name: port.MacBinding.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/port.MacBinding.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType port.MacBinding.Relationship: description: A relationship to the 'port.MacBinding' resource, or the expanded 'port.MacBinding' resource, or the 'null' value. x-one-of-name: port.MacBinding.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/port.MacBinding' port.MacBinding: title: Port:Mac Binding description: |- Establishes relationship between the ports and connected end points based on LLDP TLVs. x-allOf-name: port.MacBinding allOf: - # This 'port.MacBinding' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'port.MacBinding' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'port.MacBinding', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'port.MacBinding' ObjectType: enum: - 'port.MacBinding' AggregatePortId: description: |- Aggregate Port ID of the local Switch Interface. type: integer format: int64 x-omitempty: true ChassisId: description: |- Chassis/FEX device idetifier that is local to a cluster. type: integer format: int64 x-omitempty: true DeviceMac: description: |- Device ID value that is advertised and available as a part of LLDP TLV. type: string x-omitempty: true PortId: description: |- Port ID of the local Switch Interface. type: integer format: int64 x-omitempty: true PortMac: description: |- Port ID value that is advertised and available as a part of LLDP TLV. type: string x-omitempty: true SlotId: description: |- Slot ID of the local Switch slot Interface. type: integer format: int64 x-omitempty: true SwitchId: description: |- Switch Identifier that is local to a cluster. type: integer format: int64 x-omitempty: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true port.MacBinding.List: title: List of 'port.MacBinding' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'port.MacBinding' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'port.MacBinding' resources matching the request. type: array items: $ref: '#/components/schemas/port.MacBinding' nullable: true port.Physical: title: Port:Physical description: |- Abstract super class for all ports. x-allOf-name: port.Physical allOf: - # This 'port.Physical' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'port.Physical' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'port.Physical', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: OperState: description: |- Operational state of this port (enabled/disabled). type: string readOnly: true x-omitempty: true OperStateQual: description: |- Reason for this port's Operational state. type: string readOnly: true x-omitempty: true PortId: description: |- Switch physical port identifier. type: integer format: int64 readOnly: true x-omitempty: true Role: description: |- The role assigned to this port. type: string readOnly: true x-omitempty: true SlotId: description: |- Switch expansion slot module identifier. type: integer format: int64 readOnly: true x-omitempty: true SwitchId: description: |- Switch Identifier that is local to a cluster. type: string readOnly: true x-omitempty: true port.SubGroup.Response: description: |- The response body of a HTTP GET request for the 'port.SubGroup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'port.SubGroup' resources. x-one-of-name: port.SubGroup.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/port.SubGroup.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType port.SubGroup.Relationship: description: A relationship to the 'port.SubGroup' resource, or the expanded 'port.SubGroup' resource, or the 'null' value. x-one-of-name: port.SubGroup.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/port.SubGroup' port.SubGroup: title: Port:Sub Group description: |- Holder for multiple ports within a portGroup. SubGroup represents a break-out port group on the Fabric Interconnect. x-allOf-name: port.SubGroup allOf: - # This 'port.SubGroup' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'port.SubGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'port.SubGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'port.SubGroup' ObjectType: enum: - 'port.SubGroup' Transport: description: |- Type of port sub-group. Values are Eth or Fc. type: string readOnly: true x-omitempty: true EthernetPorts: # A Relationship to MO ether.PhysicalPort description: An array of relationships to etherPhysicalPort resources. type: array items: $ref: '#/components/schemas/ether.PhysicalPort.Relationship' nullable: true readOnly: true FcPorts: # A Relationship to MO fc.PhysicalPort description: An array of relationships to fcPhysicalPort resources. type: array items: $ref: '#/components/schemas/fc.PhysicalPort.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PortGroup: # A Relationship to MO port.Group $ref: '#/components/schemas/port.Group.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a portGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true port.SubGroup.List: title: List of 'port.SubGroup' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'port.SubGroup' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'port.SubGroup' resources matching the request. type: array items: $ref: '#/components/schemas/port.SubGroup' nullable: true processor.Unit.Response: description: |- The response body of a HTTP GET request for the 'processor.Unit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'processor.Unit' resources. x-one-of-name: processor.Unit.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/processor.Unit.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType processor.Unit.Relationship: description: A relationship to the 'processor.Unit' resource, or the expanded 'processor.Unit' resource, or the 'null' value. x-one-of-name: processor.Unit.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/processor.Unit' processor.Unit: title: Processor:Unit description: |- The CPU present on a server. x-allOf-name: processor.Unit allOf: - # This 'processor.Unit' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'processor.Unit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'processor.Unit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'processor.Unit' ObjectType: enum: - 'processor.Unit' Architecture: description: |- The architecture of the installed processor. type: string readOnly: true x-omitempty: true NumCores: description: |- The number of cores present in a given processor. type: integer format: int64 readOnly: true x-omitempty: true NumCoresEnabled: description: |- The number of enabled cores in the installed processor. type: string readOnly: true x-omitempty: true NumThreads: description: |- The maximum number of threads available in the installed processor. type: string readOnly: true x-omitempty: true OperPowerState: description: |- The power state of the processor. type: string readOnly: true x-omitempty: true OperState: description: |- The health indicator of the processor, 'OK' indicates the processor is operatinal. type: string readOnly: true x-omitempty: true Operability: description: |- Operability state of the central processing unit. type: string readOnly: true x-omitempty: true Presence: description: |- The valid values are 'equipped' and 'absent'. type: string readOnly: true x-omitempty: true ProcessorId: description: |- The ID number of a given processor. type: integer format: int64 readOnly: true x-omitempty: true SocketDesignation: description: |- The socket ID of the installed processor. type: string readOnly: true x-omitempty: true Speed: description: |- The maximum speed of the installed processor in GHz. type: number format: float readOnly: true x-omitempty: true Stepping: description: |- The CPU stepping of the installed processor. type: string readOnly: true x-omitempty: true Thermal: description: |- The temperature of the processor in centigrade. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true processor.Unit.List: title: List of 'processor.Unit' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'processor.Unit' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'processor.Unit' resources matching the request. type: array items: $ref: '#/components/schemas/processor.Unit' nullable: true recovery.AbstractBackupConfig: title: Backup Policy description: |- Base Backup config which contains all the required inputs to do backup on a local or remote server. x-allOf-name: recovery.AbstractBackupConfig allOf: - # This 'recovery.AbstractBackupConfig' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'recovery.AbstractBackupConfig' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.AbstractBackupConfig', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: FileNamePrefix: description: |- The file name for the backup image. This name is added as a prefix in the name for the backup image. A unique file name for the backup image is created along with a timestamp. For example: prefix-1572431305418. type: string x-omitempty: true IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true LocationType: description: |- Specifies whether the backup will be stored locally or remotely. * `Network Share` - The backup is stored remotely on a separate server. * `Local Storage` - The backup is stored locally on the endpoint. type: string enum: - 'Network Share' - 'Local Storage' default: Network Share x-omitempty: true Password: description: |- Password of Backup server. type: string writeOnly: true x-omitempty: true Path: description: |- The file system path where the backup images must be stored. Include the IP address/hostname of the network share location and the complete file system path. For example: 172.29.109.234/var/backups/. type: string x-omitempty: true Protocol: description: |- Protocol for transferring the backup image to the network share location. * `SCP` - Secure Copy Protocol (SCP) to access the file server. * `SFTP` - SSH File Transfer Protocol (SFTP) to access file server. * `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 the local or remote server. When the created backup files exceed this number, the initial backup files are overwritten in a sequential manner. type: integer format: int64 minimum: 1 maximum: 365 x-omitempty: true UserName: description: |- Backup server user name. 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' recovery.AbstractBackupInfo: title: Recovery:Abstract Backup Info description: |- Abstract class describing a backup. Backup objects for all devices must inherit from this class. x-allOf-name: recovery.AbstractBackupInfo allOf: - # This 'recovery.AbstractBackupInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'recovery.AbstractBackupInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.AbstractBackupInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' recovery.BackupConfigPolicy: title: Backup Policy description: |- Backup config policy which contains all the required inputs to do backup on a local or remote server. x-allOf-name: recovery.BackupConfigPolicy allOf: - # This 'recovery.BackupConfigPolicy' class inherits all properties from its parent class recovery.AbstractBackupConfig. $ref: '#/components/schemas/recovery.AbstractBackupConfig' - # The definition of all the properties specified in this 'recovery.BackupConfigPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.BackupConfigPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.BackupConfigPolicy' ObjectType: enum: - 'recovery.BackupConfigPolicy' BackupProfiles: # A Relationship to MO recovery.BackupProfile description: An array of relationships to recoveryBackupProfile resources. type: array items: $ref: '#/components/schemas/recovery.BackupProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' recovery.BackupProfile: title: BackupProfile description: |- Backup profile to initiate on-demand or scheduled backups at end points. x-allOf-name: recovery.BackupProfile allOf: - # This 'recovery.BackupProfile' class inherits all properties from its parent class policy.AbstractConfigProfile. $ref: '#/components/schemas/policy.AbstractConfigProfile' - # The definition of all the properties specified in this 'recovery.BackupProfile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.BackupProfile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.BackupProfile' ObjectType: enum: - 'recovery.BackupProfile' Enabled: description: |- Enables/Disables the schedule on the endpoint. type: boolean x-omitempty: true BackupConfig: # A Relationship to MO recovery.BackupConfigPolicy $ref: '#/components/schemas/recovery.BackupConfigPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryBackupConfigPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. ConfigResult: # A Relationship to MO recovery.ConfigResult $ref: '#/components/schemas/recovery.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true DeviceId: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true ScheduleConfig: # A Relationship to MO recovery.ScheduleConfigPolicy $ref: '#/components/schemas/recovery.ScheduleConfigPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryScheduleConfigPolicy resource. When 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. The '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: |- Encapsulates the various backup settings available to the user for scheduling a backup on the endpoint. x-allOf-name: recovery.BackupSchedule allOf: - # This 'recovery.BackupSchedule' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'recovery.BackupSchedule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.BackupSchedule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.BackupSchedule' ObjectType: enum: - 'recovery.BackupSchedule' ExecutionTime: description: |- The time at which the backup is to be run on a given day. This is used when the frequency unit is daily. type: string format: date-time x-omitempty: true FrequencyUnit: description: |- The frequency at which the backup schedule must run. * `Daily` - Allows the user to run the backup daily at a given time. * `Periodic` - Allows the user to run the backup after a certain number of hours. type: string enum: - 'Daily' - 'Periodic' default: Daily x-omitempty: true Hours: description: "The frequency, in hours, at which the backup schedule runs.\n* `8` - \n* `4` - \n* `12` - \n* `16` - \n* `20` -" type: integer enum: - 8 - 4 - 12 - 16 - 20 default: 8 x-omitempty: true recovery.ConfigParams: title: Recovery:Config Params description: |- Encapsulates the restore workflows configuration parameters. x-allOf-name: recovery.ConfigParams allOf: - # This 'recovery.ConfigParams' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' recovery.ConfigResult.Response: description: |- The response body of a HTTP GET request for the 'recovery.ConfigResult' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' recovery.ConfigResult: title: Recovery:Config Result description: |- Profile configuration (deploy, validation) results with the overall state and detailed result messages. x-allOf-name: recovery.ConfigResult allOf: - # This 'recovery.ConfigResult' class inherits all properties from its parent class policy.AbstractConfigResult. $ref: '#/components/schemas/policy.AbstractConfigResult' - # The definition of all the properties specified in this 'recovery.ConfigResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.ConfigResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.ConfigResult' ObjectType: enum: - 'recovery.ConfigResult' _0_OnDemandBackup: # A Relationship to MO recovery.OnDemandBackup $ref: '#/components/schemas/recovery.OnDemandBackup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryOnDemandBackup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true BackupProfile: # A Relationship to MO recovery.BackupProfile $ref: '#/components/schemas/recovery.BackupProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryBackupProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ResultEntries: # A Relationship to MO recovery.ConfigResultEntry 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' recovery.ConfigResultEntry: title: Recovery:Config Result Entry description: |- An entry that describes the result of a Backup Profile state on the end device. x-allOf-name: recovery.ConfigResultEntry allOf: - # This 'recovery.ConfigResultEntry' class inherits all properties from its parent class policy.AbstractConfigResultEntry. $ref: '#/components/schemas/policy.AbstractConfigResultEntry' - # The definition of all the properties specified in this 'recovery.ConfigResultEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.ConfigResultEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.ConfigResultEntry' ObjectType: enum: - 'recovery.ConfigResultEntry' ConfigResult: # A Relationship to MO recovery.ConfigResult $ref: '#/components/schemas/recovery.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryConfigResult resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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.Relationship: description: A relationship to the 'recovery.OnDemandBackup' resource, or the expanded 'recovery.OnDemandBackup' resource, or the 'null' value. x-one-of-name: recovery.OnDemandBackup.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/recovery.OnDemandBackup' recovery.OnDemandBackup: title: On Demand Backup description: |- Handles requests for on demand backup for a given endpoint. x-allOf-name: recovery.OnDemandBackup allOf: - # This 'recovery.OnDemandBackup' class inherits all properties from its parent class recovery.AbstractBackupConfig. $ref: '#/components/schemas/recovery.AbstractBackupConfig' - # The definition of all the properties specified in this 'recovery.OnDemandBackup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.OnDemandBackup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.OnDemandBackup' ObjectType: enum: - 'recovery.OnDemandBackup' ConfigResult: # A Relationship to MO recovery.ConfigResult $ref: '#/components/schemas/recovery.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true DeviceId: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Triggers a restore operation on the target endpoint. x-allOf-name: recovery.Restore allOf: - # This 'recovery.Restore' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'recovery.Restore' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.Restore', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.Restore' ObjectType: enum: - 'recovery.Restore' ConfigParams: description: |- Configuration parameters to be passed into the restore workflow. $ref: '#/components/schemas/recovery.ConfigParams' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true BackupInfo: # A Relationship to MO recovery.AbstractBackupInfo $ref: '#/components/schemas/recovery.AbstractBackupInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a recoveryAbstractBackupInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. Device: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Workflow: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' recovery.ScheduleConfigPolicy: title: Schedule Policy description: |- Base Schedule config which contains all the required inputs to do schedule on a local or remote server. x-allOf-name: recovery.ScheduleConfigPolicy allOf: - # This 'recovery.ScheduleConfigPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'recovery.ScheduleConfigPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'recovery.ScheduleConfigPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'recovery.ScheduleConfigPolicy' ObjectType: enum: - 'recovery.ScheduleConfigPolicy' Schedule: description: |- Schedule to create a backup on the target device. Minimum is 4 hours and Max is 1440 hours (30 Days). $ref: '#/components/schemas/recovery.BackupSchedule' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true BackupProfiles: # A Relationship to MO recovery.BackupProfile description: An array of relationships to recoveryBackupProfile resources. type: array items: $ref: '#/components/schemas/recovery.BackupProfile.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When 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. The '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.Group.Response: description: |- The response body of a HTTP GET request for the 'resource.Group' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' resource.Group: title: Resource:Group description: |- A group of REST resources, such as a group of compute.Blade MOs. A ResourceGroup can contain static members which are specified as a set of object references, or it can contain dynamic members, which are specified through OData query filters. A Resource can be part of multiple resource groups. x-allOf-name: resource.Group allOf: - # This 'resource.Group' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'resource.Group' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'resource.Group', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'resource.Group' ObjectType: enum: - 'resource.Group' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: 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.). * `Allow-Selectors` - Resources will be added to resource groups based on ODATA filter. Multiple resource group can be created to organize resources. * `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 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Organizations: # A Relationship to MO organization.Organization 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- A resolved member of a resource group. x-allOf-name: resource.GroupMember allOf: - # This 'resource.GroupMember' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'resource.GroupMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'resource.GroupMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'resource.GroupMember' ObjectType: enum: - 'resource.GroupMember' Group: # A Relationship to MO resource.Group $ref: '#/components/schemas/resource.Group.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a resourceGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Resource: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When 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. The '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.LicenseResourceCount.Response: description: |- The response body of a HTTP GET request for the 'resource.LicenseResourceCount' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- LicenseResourceCount tracks the server count info for 3 different licensing tiers. x-allOf-name: resource.LicenseResourceCount allOf: - # This 'resource.LicenseResourceCount' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'resource.LicenseResourceCount' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'resource.LicenseResourceCount', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'resource.LicenseResourceCount' ObjectType: enum: - 'resource.LicenseResourceCount' LicenseType: description: |- Type of licensing defined for this resource group. Used for licensing group. * `Base` - Base as a License type. It is default license type. * `Essential` - Essential as a License type. * `Standard` - Standard as a License type. * `Advantage` - Advantage as a License type. * `Premier` - Premier as a License type. type: string enum: - 'Base' - 'Essential' - 'Standard' - 'Advantage' - 'Premier' 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: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true LicenseGroups: # A Relationship to MO resource.Group 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'resource.Membership' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'resource.Membership' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'resource.Membership', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'resource.Membership' ObjectType: enum: - 'resource.Membership' GroupPermissionRoles: type: array items: description: |- Groups, organizations and their permissions to roles mapping. $ref: '#/components/schemas/iam.GroupPermissionToRoles' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true TargetApp: description: |- Name of the Service owning the resource. type: string readOnly: true x-omitempty: true Holder: # A Relationship to MO resource.MembershipHolder $ref: '#/components/schemas/resource.MembershipHolder.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a resourceMembershipHolder resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Resource: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' resource.MembershipHolder: title: Resource:Membership Holder description: |- A holder of REST resources and their membership. x-allOf-name: resource.MembershipHolder allOf: - # This 'resource.MembershipHolder' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'resource.MembershipHolder' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'resource.MembershipHolder', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'resource.MembershipHolder' ObjectType: enum: - 'resource.MembershipHolder' Name: description: |- The name of this resource membership holder. type: string readOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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.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 allOf: - # This 'resource.PerTypeCombinedSelector' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'resource.PerTypeCombinedSelector' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'resource.PerTypeCombinedSelector', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'resource.PerTypeCombinedSelector' ObjectType: enum: - 'resource.PerTypeCombinedSelector' 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.Selector: title: Resource:Selector description: |- Complex type representing the permission to roles. x-allOf-name: resource.Selector allOf: - # This 'resource.Selector' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'resource.Selector' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'resource.Selector', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'resource.Selector' ObjectType: enum: - 'resource.Selector' 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 sdcard.Diagnostics: title: Diagnostics description: |- This partition is used for diagnostics utility. This drive is available under utility partition. x-allOf-name: sdcard.Diagnostics allOf: - # This 'sdcard.Diagnostics' class inherits all properties from its parent class sdcard.VirtualDrive. $ref: '#/components/schemas/sdcard.VirtualDrive' sdcard.Drivers: title: Drivers description: |- This partition is used for drivers. This drive is available under utility partition. x-allOf-name: sdcard.Drivers allOf: - # This 'sdcard.Drivers' class inherits all properties from its parent class sdcard.VirtualDrive. $ref: '#/components/schemas/sdcard.VirtualDrive' sdcard.HostUpgradeUtility: title: Host Upgrade Utility description: |- This partition is used for host upgrade utility referred as HUU. This drive is available under utility partition. x-allOf-name: sdcard.HostUpgradeUtility allOf: - # This 'sdcard.HostUpgradeUtility' class inherits all properties from its parent class sdcard.VirtualDrive. $ref: '#/components/schemas/sdcard.VirtualDrive' sdcard.OperatingSystem: title: Operating System description: |- This partition is used for OS install and is commonly known as Hypervisor partition. This drive is available under OS partition. x-allOf-name: sdcard.OperatingSystem allOf: - # This 'sdcard.OperatingSystem' class inherits all properties from its parent class sdcard.VirtualDrive. $ref: '#/components/schemas/sdcard.VirtualDrive' - # The definition of all the properties specified in this 'sdcard.OperatingSystem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdcard.OperatingSystem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdcard.OperatingSystem' ObjectType: enum: - 'sdcard.OperatingSystem' Name: description: |- Name of virtual drive for operating system partition. type: string maxLength: 15 x-omitempty: true sdcard.Partition: title: Sdcard:Partition description: |- This adds and configures operating system partitions. x-allOf-name: sdcard.Partition allOf: - # This 'sdcard.Partition' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'sdcard.Partition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdcard.Partition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdcard.Partition' ObjectType: enum: - 'sdcard.Partition' Type: description: |- This specifies the type of the partition. Allowed values are OS, Utility. * `OS` - This partition contains virtual drives where user can install operating system. * `Utility` - This partition contains virtual drives for utilities such as SCU, HUU, Drivers and Diagnostics. type: string enum: - 'OS' - 'Utility' default: OS x-omitempty: true VirtualDrives: type: array items: description: |- Collection of available virtual drives. $ref: '#/components/schemas/sdcard.VirtualDrive' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true sdcard.Policy.Response: description: |- The response body of a HTTP GET request for the 'sdcard.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'sdcard.Policy' resources. x-one-of-name: sdcard.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/sdcard.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType sdcard.Policy: title: SD Card description: |- Policy for configuring SD Card settings on endpoint. x-allOf-name: sdcard.Policy allOf: - # This 'sdcard.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'sdcard.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdcard.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdcard.Policy' ObjectType: enum: - 'sdcard.Policy' Partitions: type: array items: description: |- Collection of configured partitions. $ref: '#/components/schemas/sdcard.Partition' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true sdcard.Policy.List: title: List of 'sdcard.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'sdcard.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'sdcard.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/sdcard.Policy' nullable: true sdcard.ServerConfigurationUtility: title: Server Configuration Utility description: |- This partition is used for server configuration utility referred as SCU. This drive is available under utility partition. x-allOf-name: sdcard.ServerConfigurationUtility allOf: - # This 'sdcard.ServerConfigurationUtility' class inherits all properties from its parent class sdcard.VirtualDrive. $ref: '#/components/schemas/sdcard.VirtualDrive' sdcard.UserPartition: title: User Partition description: |- This partition is available for user to use. This drive is available under utility partition. x-allOf-name: sdcard.UserPartition allOf: - # This 'sdcard.UserPartition' class inherits all properties from its parent class sdcard.VirtualDrive. $ref: '#/components/schemas/sdcard.VirtualDrive' - # The definition of all the properties specified in this 'sdcard.UserPartition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdcard.UserPartition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdcard.UserPartition' ObjectType: enum: - 'sdcard.UserPartition' Name: description: |- Name of virtual drive for user partition. type: string maxLength: 15 x-omitempty: true sdcard.VirtualDrive: title: Sdcard:Virtual Drive description: |- Base type for the virtual drive. x-allOf-name: sdcard.VirtualDrive allOf: - # This 'sdcard.VirtualDrive' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'sdcard.VirtualDrive' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdcard.VirtualDrive', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Enable: description: |- Enable the respective virtual drive to be available to the host. type: boolean x-omitempty: true sdwan.NetworkConfigurationType: title: Sdwan:Network Configuration Type x-allOf-name: sdwan.NetworkConfigurationType allOf: - # This 'sdwan.NetworkConfigurationType' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'sdwan.NetworkConfigurationType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdwan.NetworkConfigurationType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdwan.NetworkConfigurationType' ObjectType: enum: - 'sdwan.NetworkConfigurationType' NetworkType: description: |- Type of the Port group being added. * `WAN` - Port-group being added is used for WAN traffic. * `LAN` - Port-group being added is used for LAN traffic. * `Management` - Port-group being added is used for Management traffic. type: string enum: - 'WAN' - 'LAN' - 'Management' default: WAN x-omitempty: true PortGroup: description: |- Name of the Port Group to create. type: string minLength: 1 maxLength: 31 x-omitempty: true Vlan: description: |- VLAN to be added to the Port Group. type: integer format: int64 minimum: 0 maximum: 4095 x-omitempty: true sdwan.Profile.Response: description: |- The response body of a HTTP GET request for the 'sdwan.Profile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'sdwan.Profile' resources. x-one-of-name: sdwan.Profile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/sdwan.Profile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType sdwan.Profile.Relationship: description: A relationship to the 'sdwan.Profile' resource, or the expanded 'sdwan.Profile' resource, or the 'null' value. x-one-of-name: sdwan.Profile.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/sdwan.Profile' sdwan.Profile: title: Server Profile description: |- A profile that specifies configuration settings for a SDWAN router. x-allOf-name: sdwan.Profile allOf: - # This 'sdwan.Profile' class inherits all properties from its parent class policy.AbstractConfigProfile. $ref: '#/components/schemas/policy.AbstractConfigProfile' - # The definition of all the properties specified in this 'sdwan.Profile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdwan.Profile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdwan.Profile' ObjectType: enum: - 'sdwan.Profile' Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true RouterNodes: # A Relationship to MO sdwan.RouterNode description: An array of relationships to sdwanRouterNode resources. type: array items: $ref: '#/components/schemas/sdwan.RouterNode.Relationship' nullable: true RouterPolicy: # A Relationship to MO sdwan.RouterPolicy $ref: '#/components/schemas/sdwan.RouterPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a sdwanRouterPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. VmanageAccount: # A Relationship to MO sdwan.VmanageAccountPolicy $ref: '#/components/schemas/sdwan.VmanageAccountPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a sdwanVmanageAccountPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. sdwan.Profile.List: title: List of 'sdwan.Profile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'sdwan.Profile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'sdwan.Profile' resources matching the request. type: array items: $ref: '#/components/schemas/sdwan.Profile' nullable: true sdwan.RouterNode.Response: description: |- The response body of a HTTP GET request for the 'sdwan.RouterNode' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'sdwan.RouterNode' resources. x-one-of-name: sdwan.RouterNode.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/sdwan.RouterNode.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType sdwan.RouterNode.Relationship: description: A relationship to the 'sdwan.RouterNode' resource, or the expanded 'sdwan.RouterNode' resource, or the 'null' value. x-one-of-name: sdwan.RouterNode.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/sdwan.RouterNode' sdwan.RouterNode: title: Router Node description: |- Configuration settings for a SDWAN vEdge router. x-allOf-name: sdwan.RouterNode allOf: - # This 'sdwan.RouterNode' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'sdwan.RouterNode' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdwan.RouterNode', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdwan.RouterNode' ObjectType: enum: - 'sdwan.RouterNode' DeviceTemplate: description: |- Name of the Cisco vManage device template that the current device should be attached to. A device template consists of many feature templates that contain SD-WAN vEdge router configuration. type: string x-omitempty: true Name: description: |- Name of the router node object. type: string x-omitempty: true NetworkConfiguration: type: array items: description: |- The configuration required on the hypervisor for setting up SD-WAN networking. $ref: '#/components/schemas/sdwan.NetworkConfigurationType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true TemplateInputs: type: array items: description: |- Dynamic inputs that are expected based on the template inputs specified in the feature templates attached to the device template. $ref: '#/components/schemas/sdwan.TemplateInputsType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Uuid: description: |- Uniquely identifies the router by its chassis number. type: string pattern: "^$|^(([a-zA-Z0-9]){8}-([a-zA-Z0-9]){4}-([a-zA-Z0-9]){4}-([a-zA-Z0-9]){4}-([a-zA-Z0-9]){12})$" x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profile: # A Relationship to MO sdwan.Profile $ref: '#/components/schemas/sdwan.Profile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a sdwanProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. ServerNode: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. sdwan.RouterNode.List: title: List of 'sdwan.RouterNode' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'sdwan.RouterNode' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'sdwan.RouterNode' resources matching the request. type: array items: $ref: '#/components/schemas/sdwan.RouterNode' nullable: true sdwan.RouterPolicy.Response: description: |- The response body of a HTTP GET request for the 'sdwan.RouterPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'sdwan.RouterPolicy' resources. x-one-of-name: sdwan.RouterPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/sdwan.RouterPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType sdwan.RouterPolicy.Relationship: description: A relationship to the 'sdwan.RouterPolicy' resource, or the expanded 'sdwan.RouterPolicy' resource, or the 'null' value. x-one-of-name: sdwan.RouterPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/sdwan.RouterPolicy' sdwan.RouterPolicy: title: Router Policy description: |- A policy specifying SD-WAN router details. x-allOf-name: sdwan.RouterPolicy allOf: - # This 'sdwan.RouterPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'sdwan.RouterPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdwan.RouterPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdwan.RouterPolicy' ObjectType: enum: - 'sdwan.RouterPolicy' DeploymentSize: description: |- Scale of the SD-WAN router virtual machine deployment. * `Typical` - Typical deployment configuration with 4 vCPUs and 4GB RAM. * `Minimal` - Minimal deployment configuration with 2 vCPUs and 4GB RAM. type: string enum: - 'Typical' - 'Minimal' default: Typical x-omitempty: true WanCount: description: |- Number of WAN connections across the SD-WAN site. type: integer format: int64 minimum: 2 maximum: 3 x-omitempty: true WanTerminationType: description: |- Defines if the WAN networks are singly or dually terminated. Dually terminated WANs are configured on all the SD-WAN routers. Singly terminated WANs are configured only on one of the SD-WAN routers. * `Single` - Singly terminated WANs ar evenly distributed across SD-WAN router nodes. A given WAN connection is available only on one of the router nodes. * `Dual` - Dually terminated WANs are configured on all the SD-WAN routers. A given WAN connection is available on multiple router nodes. type: string enum: - 'Single' - 'Dual' default: Single x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO sdwan.Profile description: An array of relationships to sdwanProfile resources. type: array items: $ref: '#/components/schemas/sdwan.Profile.Relationship' nullable: true SolutionImage: # A Relationship to MO software.SolutionDistributable $ref: '#/components/schemas/software.SolutionDistributable.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwareSolutionDistributable resource. When the $expand query parameter is specified, the referenced resource is returned inline. sdwan.RouterPolicy.List: title: List of 'sdwan.RouterPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'sdwan.RouterPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'sdwan.RouterPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/sdwan.RouterPolicy' nullable: true sdwan.TemplateInputsType: title: Sdwan:Template Inputs Type description: |- Inputs that form part of the vManage Template. x-allOf-name: sdwan.TemplateInputsType allOf: - # This 'sdwan.TemplateInputsType' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'sdwan.TemplateInputsType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdwan.TemplateInputsType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdwan.TemplateInputsType' ObjectType: enum: - 'sdwan.TemplateInputsType' Editable: description: |- Defines if the input is editable. type: boolean x-omitempty: true Key: description: |- Name of the dynamic input key specified in the vManage template. type: string x-omitempty: true Required: description: |- Defines if the input is optional or required. type: boolean x-omitempty: true Template: description: |- Refers to the name of the vManage template that this inputs belongs to. type: string readOnly: true x-omitempty: true Title: description: |- Label for the property being saved in the current instance of template Input. type: string x-omitempty: true Type: description: |- Defines the object type for the input. type: string x-omitempty: true Value: description: |- Value of the dynamic input key specfied in the vManage template. type: string x-omitempty: true sdwan.VmanageAccountPolicy.Response: description: |- The response body of a HTTP GET request for the 'sdwan.VmanageAccountPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'sdwan.VmanageAccountPolicy' resources. x-one-of-name: sdwan.VmanageAccountPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/sdwan.VmanageAccountPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType sdwan.VmanageAccountPolicy.Relationship: description: A relationship to the 'sdwan.VmanageAccountPolicy' resource, or the expanded 'sdwan.VmanageAccountPolicy' resource, or the 'null' value. x-one-of-name: sdwan.VmanageAccountPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' sdwan.VmanageAccountPolicy: title: vManage Account Policy description: |- A policy specifying vManage account details. x-allOf-name: sdwan.VmanageAccountPolicy allOf: - # This 'sdwan.VmanageAccountPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'sdwan.VmanageAccountPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sdwan.VmanageAccountPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sdwan.VmanageAccountPolicy' ObjectType: enum: - 'sdwan.VmanageAccountPolicy' EndpointAddress: description: |- VManage server hostname (FQDN) that the acccount holds information for. type: string x-omitempty: true IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Password: description: |- Local password for authenticating with the vManage server. type: string writeOnly: true x-omitempty: true Port: description: |- VManage Port number on which the application is running. type: integer format: int64 x-omitempty: true Username: description: |- Local username for authenticating with the vManage server. type: string x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO sdwan.Profile description: An array of relationships to sdwanProfile resources. type: array items: $ref: '#/components/schemas/sdwan.Profile.Relationship' nullable: true sdwan.VmanageAccountPolicy.List: title: List of 'sdwan.VmanageAccountPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'sdwan.VmanageAccountPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'sdwan.VmanageAccountPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/sdwan.VmanageAccountPolicy' nullable: true search.SearchItem.Response: description: |- The response body of a HTTP GET request for the 'search.SearchItem' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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 Search service entry point to search Intersight REST resources using OData query syntax. See [Search API query syntax](/apidocs/introduction/query/#search-api) for details about the query syntax. x-allOf-name: search.SearchItem allOf: - # This 'search.SearchItem' class inherits all properties from its parent class mo.BaseMo. $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. The '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.SuggestItem: title: Search:Suggest Item description: "The Suggester service entry point to suggest Intersight REST resources using Elastic Search suggester API syntax.\nThe suggest feature suggests similar looking terms based on a provided text by using a suggester. \nSee [Search API query syntax](/apidocs/introduction/query/#global-search-api) for details\nabout the suggester query syntax." x-allOf-name: search.SuggestItem allOf: - # This 'search.SuggestItem' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'search.SuggestItem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'search.SuggestItem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'search.SuggestItem' ObjectType: enum: - 'search.SuggestItem' CompleteMo: description: |- Flag for returning complete objects that matched the global search criteria. type: boolean x-createOnly: true x-omitempty: true Rawquery: description: |- Additional filter parameters for global search. You can also specify OData select fields here. Maximum Query Length is limited to 10000. type: string maxLength: 10000 x-createOnly: true x-omitempty: true Skip: description: |- Starting offset for the results to be returned from external search engine. type: integer format: int64 x-createOnly: true x-omitempty: true SuggestTerm: description: |- Main search term used for global search across all Managed Objects that has search enabled. Search Term can be up to 200 characters long. type: string minLength: 1 maxLength: 200 x-createOnly: true x-omitempty: true Top: description: |- Maximum number of results to be returned from external search engine. type: integer format: int64 x-createOnly: true x-omitempty: true Type: description: |- Object type filter of a Managed Object. Search will be restricted only on the specified object types. Do not provide IndexMoTypes filter in the rawquery, if you specify values in this field. type: string x-createOnly: true x-omitempty: true search.TagItem.Response: description: |- The response body of a HTTP GET request for the 'search.TagItem' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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 TagItems service entry point to search Tags across all Intersight REST resources using OData Query syntax. See [Search Tags API query syntax](/apidocs/introduction/query/#search-tags-api) for details about the tag query syntax. x-allOf-name: search.TagItem allOf: - # This 'search.TagItem' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'search.TagItem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'search.TagItem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'search.TagItem' ObjectType: enum: - 'search.TagItem' 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 Values: type: array items: description: |- All values corresponding to the tag key in the results. type: string readOnly: true x-omitempty: 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. The '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 security.Unit.Response: description: |- The response body of a HTTP GET request for the 'security.Unit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'security.Unit' resources. x-one-of-name: security.Unit.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/security.Unit.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType security.Unit.Relationship: description: A relationship to the 'security.Unit' resource, or the expanded 'security.Unit' resource, or the 'null' value. x-one-of-name: security.Unit.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/security.Unit' security.Unit: title: Security:Unit description: |- The crypto card present on a server. x-allOf-name: security.Unit allOf: - # This 'security.Unit' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'security.Unit' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'security.Unit', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'security.Unit' ObjectType: enum: - 'security.Unit' OperState: description: |- Operational state of the security unit. type: string readOnly: true x-omitempty: true Operability: description: |- Operability state of the security unit. type: string readOnly: true x-omitempty: true PartNumber: description: |- The part number of the security unit. type: string readOnly: true x-omitempty: true PciSlot: description: |- PCIe slot of the security unit in the server. type: string readOnly: true x-omitempty: true Power: description: |- Power state of the security unit. type: string readOnly: true x-omitempty: true Presence: description: |- Security unit presence (equipped) or absence. type: string readOnly: true x-omitempty: true Thermal: description: |- Thermal state of the security unit. type: string readOnly: true x-omitempty: true UnitId: description: |- The unique identifier assigned to the security unit within the server. type: integer format: int64 readOnly: true x-omitempty: true Vid: description: |- The vendor identifier of the security unit. type: string readOnly: true x-omitempty: true Voltage: description: |- The voltage state of the security unit. type: string readOnly: true x-omitempty: true ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true security.Unit.List: title: List of 'security.Unit' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'security.Unit' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'security.Unit' resources matching the request. type: array items: $ref: '#/components/schemas/security.Unit' nullable: true server.ConfigChangeDetail.Response: description: |- The response body of a HTTP GET request for the 'server.ConfigChangeDetail' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'server.ConfigChangeDetail' resources. x-one-of-name: server.ConfigChangeDetail.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/server.ConfigChangeDetail.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType server.ConfigChangeDetail.Relationship: description: A relationship to the 'server.ConfigChangeDetail' resource, or the expanded 'server.ConfigChangeDetail' resource, or the 'null' value. x-one-of-name: server.ConfigChangeDetail.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/server.ConfigChangeDetail' server.ConfigChangeDetail: title: Server:Config Change Detail description: |- The configuration change details are captured here. x-allOf-name: server.ConfigChangeDetail allOf: - # This 'server.ConfigChangeDetail' class inherits all properties from its parent class policy.AbstractConfigChangeDetail. $ref: '#/components/schemas/policy.AbstractConfigChangeDetail' - # The definition of all the properties specified in this 'server.ConfigChangeDetail' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'server.ConfigChangeDetail', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'server.ConfigChangeDetail' ObjectType: enum: - 'server.ConfigChangeDetail' Profile: # A Relationship to MO server.Profile $ref: '#/components/schemas/server.Profile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a serverProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true server.ConfigChangeDetail.List: title: List of 'server.ConfigChangeDetail' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'server.ConfigChangeDetail' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'server.ConfigChangeDetail' resources matching the request. type: array items: $ref: '#/components/schemas/server.ConfigChangeDetail' nullable: true server.ConfigImport.Response: description: |- The response body of a HTTP GET request for the 'server.ConfigImport' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'server.ConfigImport' resources. x-one-of-name: server.ConfigImport.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/server.ConfigImport.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType server.ConfigImport: title: Server:Config Import description: |- Configuration import action will import the existing configuration from physical server and generate Intersight policies and server profile from it. At end of successful import, server will be assigned to the generated profile which has policies associated with it. No server profile or policies will be generated if configuration import fails. x-allOf-name: server.ConfigImport allOf: - # This 'server.ConfigImport' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'server.ConfigImport' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'server.ConfigImport', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'server.ConfigImport' ObjectType: enum: - 'server.ConfigImport' Description: description: |- Description of the imported profile. type: string x-omitempty: true PolicyPrefix: description: |- Policy prefix for the policies of the imported server profile. type: string pattern: "^[a-zA-Z0-9_.:-]{1,32}$" x-omitempty: true PolicyTypes: type: array items: description: |- Types of the policies to be imported for the imported server profile. type: string x-omitempty: true ProfileName: description: |- Profile name for the imported server profile. type: string pattern: "^[a-zA-Z0-9_.-]{1,64}$" x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Server: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. ServerProfile: # A Relationship to MO server.Profile $ref: '#/components/schemas/server.Profile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a serverProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true server.ConfigImport.List: title: List of 'server.ConfigImport' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'server.ConfigImport' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'server.ConfigImport' resources matching the request. type: array items: $ref: '#/components/schemas/server.ConfigImport' nullable: true server.ConfigResult.Response: description: |- The response body of a HTTP GET request for the 'server.ConfigResult' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'server.ConfigResult' resources. x-one-of-name: server.ConfigResult.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/server.ConfigResult.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType server.ConfigResult.Relationship: description: A relationship to the 'server.ConfigResult' resource, or the expanded 'server.ConfigResult' resource, or the 'null' value. x-one-of-name: server.ConfigResult.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/server.ConfigResult' server.ConfigResult: title: Server:Config Result description: |- The profile configuration (deploy, validation) results with the overall state and detailed result messages. x-allOf-name: server.ConfigResult allOf: - # This 'server.ConfigResult' class inherits all properties from its parent class policy.AbstractConfigResult. $ref: '#/components/schemas/policy.AbstractConfigResult' - # The definition of all the properties specified in this 'server.ConfigResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'server.ConfigResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'server.ConfigResult' ObjectType: enum: - 'server.ConfigResult' Profile: # A Relationship to MO server.Profile $ref: '#/components/schemas/server.Profile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a serverProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ResultEntries: # A Relationship to MO server.ConfigResultEntry description: An array of relationships to serverConfigResultEntry resources. type: array items: $ref: '#/components/schemas/server.ConfigResultEntry.Relationship' nullable: true server.ConfigResult.List: title: List of 'server.ConfigResult' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'server.ConfigResult' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'server.ConfigResult' resources matching the request. type: array items: $ref: '#/components/schemas/server.ConfigResult' nullable: true server.ConfigResultEntry.Response: description: |- The response body of a HTTP GET request for the 'server.ConfigResultEntry' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'server.ConfigResultEntry' resources. x-one-of-name: server.ConfigResultEntry.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/server.ConfigResultEntry.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType server.ConfigResultEntry.Relationship: description: A relationship to the 'server.ConfigResultEntry' resource, or the expanded 'server.ConfigResultEntry' resource, or the 'null' value. x-one-of-name: server.ConfigResultEntry.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/server.ConfigResultEntry' server.ConfigResultEntry: title: Server:Config Result Entry description: |- The profile configuration (deploy, validation) results details information. x-allOf-name: server.ConfigResultEntry allOf: - # This 'server.ConfigResultEntry' class inherits all properties from its parent class policy.AbstractConfigResultEntry. $ref: '#/components/schemas/policy.AbstractConfigResultEntry' - # The definition of all the properties specified in this 'server.ConfigResultEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'server.ConfigResultEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'server.ConfigResultEntry' ObjectType: enum: - 'server.ConfigResultEntry' ConfigResult: # A Relationship to MO server.ConfigResult $ref: '#/components/schemas/server.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a serverConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. server.ConfigResultEntry.List: title: List of 'server.ConfigResultEntry' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'server.ConfigResultEntry' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'server.ConfigResultEntry' resources matching the request. type: array items: $ref: '#/components/schemas/server.ConfigResultEntry' nullable: true server.Profile.Response: description: |- The response body of a HTTP GET request for the 'server.Profile' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'server.Profile' resources. x-one-of-name: server.Profile.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/server.Profile.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType server.Profile.Relationship: description: A relationship to the 'server.Profile' resource, or the expanded 'server.Profile' resource, or the 'null' value. x-one-of-name: server.Profile.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/server.Profile' server.Profile: title: Server Profile description: |- A profile specifying configuration settings for a physical server. x-allOf-name: server.Profile allOf: - # This 'server.Profile' class inherits all properties from its parent class policy.AbstractConfigProfile. $ref: '#/components/schemas/policy.AbstractConfigProfile' - # The definition of all the properties specified in this 'server.Profile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'server.Profile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'server.Profile' ObjectType: enum: - 'server.Profile' ConfigChanges: description: |- Pending configuration changes at the summary level. Detail changes are saved in configChangeDetails as a separate object. $ref: '#/components/schemas/policy.ConfigChange' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IsPmcDeployedSecurePassphraseSet: description: |- Indicates whether the value of the 'pmcDeployedSecurePassphrase' property has been set. type: boolean readOnly: true x-omitempty: true PmcDeployedSecurePassphrase: description: |- Secure passphrase that is already deployed on all the Persistent Memory Modules on the server. This deployed passphrase is required during deploy of server profile if secure passphrase is changed or security is disabled in the attached persistent memory policy. type: string writeOnly: true x-omitempty: true TargetPlatform: description: |- The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight. * `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. * `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight. type: string enum: - 'Standalone' - 'FIAttached' default: Standalone x-omitempty: true AssignedServer: # A Relationship to MO compute.Physical $ref: '#/components/schemas/compute.Physical.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computePhysical resource. When the $expand query parameter is specified, the referenced resource is returned inline. AssociatedServer: # A Relationship to MO compute.Physical $ref: '#/components/schemas/compute.Physical.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computePhysical resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ConfigChangeDetails: # A Relationship to MO server.ConfigChangeDetail description: An array of relationships to serverConfigChangeDetail resources. type: array items: $ref: '#/components/schemas/server.ConfigChangeDetail.Relationship' nullable: true readOnly: true ConfigResult: # A Relationship to MO server.ConfigResult $ref: '#/components/schemas/server.ConfigResult.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a serverConfigResult resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true RunningWorkflows: # A Relationship to MO workflow.WorkflowInfo description: An array of relationships to workflowWorkflowInfo resources. type: array items: $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' nullable: true readOnly: true server.Profile.List: title: List of 'server.Profile' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'server.Profile' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'server.Profile' resources matching the request. type: array items: $ref: '#/components/schemas/server.Profile' nullable: true smtp.Policy.Response: description: |- The response body of a HTTP GET request for the 'smtp.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'smtp.Policy' resources. x-one-of-name: smtp.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/smtp.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType smtp.Policy: title: SMTP description: |- Name that identifies the SMTP Policy. x-allOf-name: smtp.Policy allOf: - # This 'smtp.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'smtp.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'smtp.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'smtp.Policy' ObjectType: enum: - 'smtp.Policy' Enabled: description: |- If enabled, controls the state of the SMTP client service on the managed device. type: boolean x-omitempty: true MinSeverity: description: |- Minimum fault severity level to receive email notifications. Email notifications are sent for all faults whose severity is equal to or greater than the chosen level. * `critical` - Minimum severity to report is critical. * `condition` - Minimum severity to report is informational. * `warning` - Minimum severity to report is warning. * `minor` - Minimum severity to report is minor. * `major` - Minimum severity to report is major. type: string enum: - 'critical' - 'condition' - 'warning' - 'minor' - 'major' default: critical x-omitempty: true SenderEmail: description: |- The email address entered here will be displayed as the from address (mail received from address) of all the SMTP mail alerts that are received. If not configured, the hostname of the server is used in the from address field. type: string pattern: "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$" x-omitempty: true SmtpPort: description: |- Port number used by the SMTP server for outgoing SMTP communication. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true SmtpRecipients: type: array items: description: |- List of email addresses that will receive notifications for faults. type: string pattern: "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$" x-omitempty: true SmtpServer: description: |- IP address or hostname of the SMTP server. The SMTP server is used by the managed device to send email notifications. type: string x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true smtp.Policy.List: title: List of 'smtp.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'smtp.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'smtp.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/smtp.Policy' nullable: true snmp.Policy.Response: description: |- The response body of a HTTP GET request for the 'snmp.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'snmp.Policy' resources. x-one-of-name: snmp.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/snmp.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType snmp.Policy: title: SNMP description: |- Policy to configure SNMP settings on endpoint. x-allOf-name: snmp.Policy allOf: - # This 'snmp.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'snmp.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'snmp.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'snmp.Policy' ObjectType: enum: - 'snmp.Policy' AccessCommunityString: description: |- The default SNMPv1, SNMPv2c community name or SNMPv3 username to include on any trap messages sent to the SNMP host. The name can be 18 characters long. type: string maxLength: 18 x-omitempty: true CommunityAccess: description: |- Controls access to the information in the inventory tables. Applicable only for SNMPv1 and SNMPv2c users. * `Disabled` - Blocks access to the information in the inventory tables. * `Limited` - Partial access to read the information in the inventory tables. * `Full` - Full access to read the information in the inventory tables. type: string enum: - 'Disabled' - 'Limited' - 'Full' default: Disabled x-omitempty: true Enabled: description: |- State of the SNMP Policy on the endpoint. If enabled, the endpoint sends SNMP traps to the designated host. type: boolean x-omitempty: true EngineId: description: |- User-defined unique identification of the static engine. type: string pattern: "^[^#!&]*$" maxLength: 27 x-omitempty: true SnmpPort: description: |- Port on which Cisco IMC SNMP agent runs. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true SnmpTraps: type: array items: description: |- List of SNMP traps for the policy. $ref: '#/components/schemas/snmp.Trap' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true maxItems: 15 SnmpUsers: type: array items: description: |- List of SNMP users for the policy. $ref: '#/components/schemas/snmp.User' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true maxItems: 15 SysContact: description: |- Contact person responsible for the SNMP implementation. Enter a string up to 64 characters, such as an email address or a name and telephone number. type: string maxLength: 64 x-omitempty: true SysLocation: description: |- Location of host on which the SNMP agent (server) runs. type: string maxLength: 64 x-omitempty: true TrapCommunity: description: |- SNMP community group used for sending SNMP trap to other devices. Valid only for SNMPv2c users. type: string maxLength: 18 x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true snmp.Policy.List: title: List of 'snmp.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'snmp.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'snmp.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/snmp.Policy' nullable: true snmp.Trap: title: Snmp:Trap description: |- Complex type that models a trap message sent from an agent to the manager. x-allOf-name: snmp.Trap allOf: - # This 'snmp.Trap' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'snmp.Trap' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'snmp.Trap', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'snmp.Trap' ObjectType: enum: - 'snmp.Trap' Destination: description: |- Address to which the SNMP trap information is sent. type: string x-omitempty: true Enabled: description: |- Enables/disables the trap on the server If enabled, trap is active on the server. type: boolean x-omitempty: true Port: description: |- Port used by the server to communicate with trap destination. Enter a value between 1-65535. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true Type: description: |- Type of trap which decides whether to receive a notification when a trap is received at the destination. * `Trap` - Do not receive notifications when trap is sent to the destination. * `Inform` - Receive notifications when trap is sent to the destination. This option is valid only for V2 users. type: string enum: - 'Trap' - 'Inform' default: Trap x-omitempty: true User: description: |- SNMP user for the trap. Applicable only to SNMPv3. type: string x-omitempty: true Version: description: |- SNMP version used for the trap. * `V3` - SNMP v3 trap version notifications. * `V2` - SNMP v2 trap version notifications. type: string enum: - 'V3' - 'V2' default: V3 x-omitempty: true snmp.User: title: Snmp:User description: |- Complex type for a User based security model, for communication between an agent and manager. Applicable only for SNMPv3. x-allOf-name: snmp.User allOf: - # This 'snmp.User' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'snmp.User' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'snmp.User', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'snmp.User' ObjectType: enum: - 'snmp.User' AuthPassword: description: |- Authorization password for the user. type: string writeOnly: true x-omitempty: true AuthType: description: |- Authorization protocol for authenticating the user. * `NA` - Authentication protocol is not applicable. * `MD5` - MD5 protocol is used to authenticate SNMP user. * `SHA` - SHA protocol is used to authenticate SNMP user. type: string enum: - 'NA' - 'MD5' - 'SHA' default: NA x-omitempty: true IsAuthPasswordSet: description: |- Indicates whether the value of the 'authPassword' property has been set. type: boolean readOnly: true x-omitempty: true IsPrivacyPasswordSet: description: |- Indicates whether the value of the 'privacyPassword' property has been set. type: boolean readOnly: true x-omitempty: true Name: description: |- SNMP username. Must have a minimum of 1 and and a maximum of 31 characters. type: string minLength: 1 maxLength: 31 x-omitempty: true PrivacyPassword: description: |- Privacy password for the user. type: string writeOnly: true x-omitempty: true PrivacyType: description: |- Privacy protocol for the user. * `NA` - Privacy protocol is not applicable. * `DES` - DES privacy protocol is used for SNMP user. * `AES` - AES privacy protocol is used for SNMP user. type: string enum: - 'NA' - 'DES' - 'AES' default: NA x-omitempty: true SecurityLevel: description: |- Security mechanism used for communication between agent and manager. * `AuthPriv` - The user requires both an authorization password and a privacy password. * `NoAuthNoPriv` - The user does not require an authorization or privacy password. * `AuthNoPriv` - The user requires an authorization password but not a privacy password. type: string enum: - 'AuthPriv' - 'NoAuthNoPriv' - 'AuthNoPriv' default: AuthPriv x-omitempty: true software.ApplianceDistributable.Response: description: |- The response body of a HTTP GET request for the 'software.ApplianceDistributable' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Appliance image distributed by Cisco. This image is required to upgrade the on-premise Intersight Appliance. There are two use cases. In Intersight SaaS, the object represents a downloadable image, whereas on the Appliance the represents the image that is uploaded by the user and to be used for upgrade. x-allOf-name: software.ApplianceDistributable allOf: - # This 'software.ApplianceDistributable' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'software.ApplianceDistributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'software.ApplianceDistributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'software.ApplianceDistributable' ObjectType: enum: - 'software.ApplianceDistributable' Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When 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. The '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.HclMeta.Response: description: |- The response body of a HTTP GET request for the 'software.HclMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'software.HclMeta' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'software.HclMeta' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'software.HclMeta', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'software.HclMeta' ObjectType: enum: - 'software.HclMeta' ContentType: description: |- The type of content that the Json file holds (Incremental or full dump). * `Full` - Indicates that the JSON File does have full content for HCL metadata. * `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: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'software.HyperflexBundleDistributable' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'software.HyperflexBundleDistributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'software.HyperflexBundleDistributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'software.HyperflexBundleDistributable' ObjectType: enum: - 'software.HyperflexBundleDistributable' Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Images: # A Relationship to MO software.HyperflexDistributable 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' software.HyperflexDistributable: title: HyperFlex description: |- A HyperFlex image distributed by Cisco. x-allOf-name: software.HyperflexDistributable allOf: - # This 'software.HyperflexDistributable' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'software.HyperflexDistributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'software.HyperflexDistributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'software.HyperflexDistributable' ObjectType: enum: - 'software.HyperflexDistributable' Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When 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. The '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.SolutionDistributable.Response: description: |- The response body of a HTTP GET request for the 'software.SolutionDistributable' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' software.SolutionDistributable: title: Solution distributable image description: |- A solution image distributed by Cisco. x-allOf-name: software.SolutionDistributable allOf: - # This 'software.SolutionDistributable' class inherits all properties from its parent class firmware.BaseDistributable. $ref: '#/components/schemas/firmware.BaseDistributable' - # The definition of all the properties specified in this 'software.SolutionDistributable' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'software.SolutionDistributable', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'software.SolutionDistributable' ObjectType: enum: - 'software.SolutionDistributable' 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. * `osimage` - The solution OS image for deployment. * `script` - The Python script for the solution VM configuration and deployment. type: string enum: - 'osimage' - 'script' default: osimage x-omitempty: true Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When 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. The '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 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: - # This 'softwarerepository.ApplianceUpload' class inherits all properties from its parent class softwarerepository.FileServer. $ref: '#/components/schemas/softwarerepository.FileServer' softwarerepository.Authorization.Response: description: |- The response body of a HTTP GET request for the 'softwarerepository.Authorization' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'softwarerepository.Authorization' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'softwarerepository.Authorization' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.Authorization', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.Authorization' ObjectType: enum: - 'softwarerepository.Authorization' IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true IsUserIdSet: description: |- Indicates whether the value of the 'userId' property has been set. type: boolean 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. * `Cisco` - External repository hosted on cisco.com. * `IntersightCloud` - Repository hosted by the Intersight Cloud. * `LocalMachine` - The file is available on the local client machine. Used as an upload source type. * `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 writeOnly: true x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When 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. The '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.CachedImage.Response: description: |- The response body of a HTTP GET request for the 'softwarerepository.CachedImage' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'softwarerepository.CachedImage' class inherits all properties from its parent class connector.DownloadStatus. $ref: '#/components/schemas/connector.DownloadStatus' - # The definition of all the properties specified in this 'softwarerepository.CachedImage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.CachedImage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.CachedImage' ObjectType: enum: - 'softwarerepository.CachedImage' 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. * `None` - No action should be taken on the imported file. * `GeneratePreSignedUploadUrl` - Generate pre signed URL of file for importing into the repository. * `GeneratePreSignedDownloadUrl` - Generate pre signed URL of file in the repository to download. * `CompleteImportProcess` - Mark that the import process of the file into the repository is complete. * `MarkImportFailed` - Mark to indicate that the import process of the file into the repository failed. * `PreCache` - Cache the file into the Intersight Appliance. * `Cancel` - The cancel import process for the file into the repository. * `Extract` - The action to extract the file in the external repository. * `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. * `ReadyForImport` - The image is ready to be imported into the repository. * `Importing` - The image is being imported into the repository. * `Imported` - The image has been extracted and imported into the repository. * `PendingExtraction` - Indicates that the image has been imported but not extracted in the repository. * `Extracting` - Indicates that the image is being extracted into the repository. * `Extracted` - Indicates that the image has been extracted into the repository. * `Failed` - The image import from an external source to the repository has failed. * `MetaOnly` - The image is present in an external repository. * `ReadyForCache` - The image is ready to be cached into the Intersight Appliance. * `Caching` - Indicates that the image is being cached into the Intersight Appliance or endpoint cache. * `Cached` - Indicates that the image has been cached into the Intersight Appliance or endpoint cache. * `CachingFailed` - Indicates that the image caching into the Intersight Appliance failed or endpoint cache. * `Corrupted` - Indicates that the image in the local repository (or endpoint cache) has been corrupted after it was cached. * `Evicted` - Indicates that the image has been evicted from the Intersight Appliance (or endpoint cache) to reclaim storage space. type: string enum: - 'ReadyForImport' - 'Importing' - 'Imported' - 'PendingExtraction' - 'Extracting' - 'Extracted' - 'Failed' - 'MetaOnly' - 'ReadyForCache' - 'Caching' - 'Cached' - 'CachingFailed' - 'Corrupted' - 'Evicted' 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 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: # A Relationship to MO softwarerepository.File $ref: '#/components/schemas/softwarerepository.File.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryFile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'softwarerepository.Catalog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'softwarerepository.Catalog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.Catalog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.Catalog' ObjectType: enum: - 'softwarerepository.Catalog' Name: description: |- The name of the catalog. The names are populated and predefined during MO creation. type: string readOnly: true x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true System: # A Relationship to MO iam.System $ref: '#/components/schemas/iam.System.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamSystem resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Maps a Cisco software repository image category identifier to its applicable hardware models. x-allOf-name: softwarerepository.CategoryMapper allOf: - # This 'softwarerepository.CategoryMapper' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'softwarerepository.CategoryMapper' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.CategoryMapper', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.CategoryMapper' ObjectType: enum: - 'softwarerepository.CategoryMapper' 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. * `Distributable` - Stores firmware host utility images and fabric images. * `DriverDistributable` - Stores driver distributable images. * `ServerConfigurationUtilityDistributable` - Stores server configuration utility images. * `OperatingSystemFile` - Stores operating system iso images. * `HyperflexDistributable` - It stores HyperFlex images. type: string enum: - 'Distributable' - 'DriverDistributable' - 'ServerConfigurationUtilityDistributable' - 'OperatingSystemFile' - 'HyperflexDistributable' default: Distributable 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. * `Cisco` - External repository hosted on cisco.com. * `IntersightCloud` - Repository hosted by the Intersight Cloud. * `LocalMachine` - The file is available on the local client machine. Used as an upload source type. * `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 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 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Maps a Cisco hardware model Series to its applicable hardware models. x-allOf-name: softwarerepository.CategoryMapperModel allOf: - # This 'softwarerepository.CategoryMapperModel' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'softwarerepository.CategoryMapperModel' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.CategoryMapperModel', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.CategoryMapperModel' ObjectType: enum: - 'softwarerepository.CategoryMapperModel' 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 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 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: |- Defines constraints for models which are supported from certain minimum image version. x-allOf-name: softwarerepository.CategorySupportConstraint allOf: - # This 'softwarerepository.CategorySupportConstraint' class inherits all properties from its parent class capability.Capability. $ref: '#/components/schemas/capability.Capability' - # The definition of all the properties specified in this 'softwarerepository.CategorySupportConstraint' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.CategorySupportConstraint', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.CategorySupportConstraint' ObjectType: enum: - 'softwarerepository.CategorySupportConstraint' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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 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. The '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.CifsServer: title: CIFS description: |- An external file repository accessible through the CIFS protocol. x-allOf-name: softwarerepository.CifsServer allOf: - # This 'softwarerepository.CifsServer' class inherits all properties from its parent class softwarerepository.FileServer. $ref: '#/components/schemas/softwarerepository.FileServer' - # The definition of all the properties specified in this 'softwarerepository.CifsServer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.CifsServer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.CifsServer' ObjectType: enum: - 'softwarerepository.CifsServer' 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 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 " . * soft. * nounix. * noserviceino. * guest. * USERNAME=VALUE. * PASSWORD=VALUE. * 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 allOf: - # This 'softwarerepository.ConstraintModels' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'softwarerepository.ConstraintModels' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.ConstraintModels', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.ConstraintModels' ObjectType: enum: - 'softwarerepository.ConstraintModels' 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 softwarerepository.DownloadSpec.Response: description: |- The response body of a HTTP GET request for the 'softwarerepository.DownloadSpec' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'softwarerepository.DownloadSpec' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'softwarerepository.DownloadSpec' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.DownloadSpec', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.DownloadSpec' ObjectType: enum: - 'softwarerepository.DownloadSpec' 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 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: # A Relationship to MO softwarerepository.File $ref: '#/components/schemas/softwarerepository.File.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryFile resource. When 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. The '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' 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: - # This 'softwarerepository.File' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'softwarerepository.File' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.File', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: 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 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. * `None` - No action should be taken on the imported file. * `GeneratePreSignedUploadUrl` - Generate pre signed URL of file for importing into the repository. * `GeneratePreSignedDownloadUrl` - Generate pre signed URL of file in the repository to download. * `CompleteImportProcess` - Mark that the import process of the file into the repository is complete. * `MarkImportFailed` - Mark to indicate that the import process of the file into the repository failed. * `PreCache` - Cache the file into the Intersight Appliance. * `Cancel` - The cancel import process for the file into the repository. * `Extract` - The action to extract the file in the external repository. * `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. * `ReadyForImport` - The image is ready to be imported into the repository. * `Importing` - The image is being imported into the repository. * `Imported` - The image has been extracted and imported into the repository. * `PendingExtraction` - Indicates that the image has been imported but not extracted in the repository. * `Extracting` - Indicates that the image is being extracted into the repository. * `Extracted` - Indicates that the image has been extracted into the repository. * `Failed` - The image import from an external source to the repository has failed. * `MetaOnly` - The image is present in an external repository. * `ReadyForCache` - The image is ready to be cached into the Intersight Appliance. * `Caching` - Indicates that the image is being cached into the Intersight Appliance or endpoint cache. * `Cached` - Indicates that the image has been cached into the Intersight Appliance or endpoint cache. * `CachingFailed` - Indicates that the image caching into the Intersight Appliance failed or endpoint cache. * `Corrupted` - Indicates that the image in the local repository (or endpoint cache) has been corrupted after it was cached. * `Evicted` - Indicates that the image has been evicted from the Intersight Appliance (or endpoint cache) to reclaim storage space. type: string enum: - 'ReadyForImport' - 'Importing' - 'Imported' - 'PendingExtraction' - 'Extracting' - 'Extracted' - 'Failed' - 'MetaOnly' - 'ReadyForCache' - 'Caching' - 'Cached' - 'CachingFailed' - 'Corrupted' - 'Evicted' 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 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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. For more information, please refer to the softwarerepositoryUploader and softwarerepositoryFile object descriptions where this type is used. x-allOf-name: softwarerepository.FileServer allOf: - # This 'softwarerepository.FileServer' class inherits all properties from its parent class mo.BaseComplexType. $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: - # This 'softwarerepository.HttpServer' class inherits all properties from its parent class softwarerepository.FileServer. $ref: '#/components/schemas/softwarerepository.FileServer' - # The definition of all the properties specified in this 'softwarerepository.HttpServer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.HttpServer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.HttpServer' ObjectType: enum: - 'softwarerepository.HttpServer' IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean 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 allOf: - # This 'softwarerepository.ImportResult' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'softwarerepository.ImportResult' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.ImportResult', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.ImportResult' ObjectType: enum: - 'softwarerepository.ImportResult' 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: - # This 'softwarerepository.LocalMachine' class inherits all properties from its parent class softwarerepository.FileServer. $ref: '#/components/schemas/softwarerepository.FileServer' - # The definition of all the properties specified in this 'softwarerepository.LocalMachine' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.LocalMachine', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.LocalMachine' ObjectType: enum: - 'softwarerepository.LocalMachine' 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 softwarerepository.NfsServer: title: NFS description: |- An external file repository accessible through the NFS protocol. x-allOf-name: softwarerepository.NfsServer allOf: - # This 'softwarerepository.NfsServer' class inherits all properties from its parent class softwarerepository.FileServer. $ref: '#/components/schemas/softwarerepository.FileServer' - # The definition of all the properties specified in this 'softwarerepository.NfsServer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.NfsServer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.NfsServer' ObjectType: enum: - 'softwarerepository.NfsServer' 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 " . * ro. * rw. * nolock. * noexec. * soft. * PORT=VALUE. * timeo=VALUE. * 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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' softwarerepository.OperatingSystemFile: title: Operating System description: |- An operating system image 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. x-allOf-name: softwarerepository.OperatingSystemFile allOf: - # This 'softwarerepository.OperatingSystemFile' class inherits all properties from its parent class softwarerepository.File. $ref: '#/components/schemas/softwarerepository.File' - # The definition of all the properties specified in this 'softwarerepository.OperatingSystemFile' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.OperatingSystemFile', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.OperatingSystemFile' ObjectType: enum: - 'softwarerepository.OperatingSystemFile' Vendor: description: |- The vendor or publisher of this file. type: string x-omitempty: true Catalog: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When 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. The '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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'softwarerepository.Release' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'softwarerepository.Release' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'softwarerepository.Release', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'softwarerepository.Release' ObjectType: enum: - 'softwarerepository.Release' 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 Type: description: |- The platform type for which the images are released. This can be a fabric interconnect or compute server hardware. * `FabricSwitch` - The images in a release that correspond to Fabric Interconnect switches. * `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: # A Relationship to MO softwarerepository.Catalog $ref: '#/components/schemas/softwarerepository.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a softwarerepositoryCatalog resource. When 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. The '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 sol.Policy.Response: description: |- The response body of a HTTP GET request for the 'sol.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'sol.Policy' resources. x-one-of-name: sol.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/sol.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType sol.Policy: title: Serial Over LAN description: |- Policy for configuring Serial Over LAN settings on endpoint. x-allOf-name: sol.Policy allOf: - # This 'sol.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'sol.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'sol.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'sol.Policy' ObjectType: enum: - 'sol.Policy' BaudRate: description: |- Baud Rate used for Serial Over LAN communication. * `9600` - Use baud rate 9600 for communication. * `19200` - Use baud rate 19200 for communication. * `38400` - Use baud rate 38400 for communication. * `57600` - Use baud rate 57600 for communication. * `115200` - Use baud rate 115200 for communication. type: integer enum: - 9600 - 19200 - 38400 - 57600 - 115200 default: 9600 x-omitempty: true ComPort: description: |- Serial port through which the system routes Serial Over LAN communication. This field is available only on some Cisco UCS C-Series servers. If it is unavailable, the server uses COM port 0 by default. * `com0` - Use serial port com0 for communication. * `com1` - Use serial port com1 for communication. type: string enum: - 'com0' - 'com1' default: com0 x-omitempty: true Enabled: description: |- State of Serial Over LAN service on the endpoint. type: boolean x-omitempty: true SshPort: description: |- SSH port used to access Serial Over LAN directly. Enables bypassing Cisco IMC shell to provide direct access to Serial Over LAN. type: integer format: int64 minimum: 1024 maximum: 65535 x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true sol.Policy.List: title: List of 'sol.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'sol.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'sol.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/sol.Policy' nullable: true ssh.Policy.Response: description: |- The response body of a HTTP GET request for the 'ssh.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ssh.Policy' resources. x-one-of-name: ssh.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ssh.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ssh.Policy: title: SSH description: |- Secure shell policy on the endpoint. x-allOf-name: ssh.Policy allOf: - # This 'ssh.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'ssh.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ssh.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ssh.Policy' ObjectType: enum: - 'ssh.Policy' Enabled: description: |- State of SSH service on the endpoint. type: boolean x-omitempty: true Port: description: |- Port used for secure shell access. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true Timeout: description: |- Number of seconds to wait before the system considers a SSH request to have timed out. type: integer format: int64 minimum: 60 maximum: 10800 x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true ssh.Policy.List: title: List of 'ssh.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ssh.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ssh.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/ssh.Policy' nullable: true storage.BaseArray: title: Storage:Base Array description: |- Abstract object which contains common attributes of a storage array. Every storage array should inherit from this object. x-allOf-name: storage.BaseArray allOf: - # This 'storage.BaseArray' class inherits all properties from its parent class equipment.AbstractDevice. $ref: '#/components/schemas/equipment.AbstractDevice' - # The definition of all the properties specified in this 'storage.BaseArray' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseArray', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: StorageUtilization: description: |- Storage utilization of an array. It contains total capacity, available capacity, and used capacity. $ref: '#/components/schemas/storage.BaseCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true storage.BaseArrayController: title: Storage:Base Array Controller description: |- Common attributes for a Storage array controller. It can be a hardware or software unit which manages the physical storage disks available in the array. x-allOf-name: storage.BaseArrayController allOf: - # This 'storage.BaseArrayController' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.BaseArrayController' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseArrayController', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- Storage array controller name. type: string readOnly: true x-omitempty: true OperationalMode: description: |- Controller running mode, Primary or Secondary. * `Unknown` - Component operational state is unknown. * `Primary` - Component operates in primary mode and accepts workloads. * `Secondary` - Component is running as a secondary or standby mode. * `Maintenance` - Component is in maintenance mode for upgrade. During maintenance mode, component does not perform any workload. type: string enum: - 'Unknown' - 'Primary' - 'Secondary' - 'Maintenance' default: Unknown readOnly: true x-omitempty: true Status: description: |- Status of the storage controller. * `Unknown` - Component status is not available. * `Ok` - Component is healthy and no issues found. * `Degraded` - Functioning, but not at full capability due to a non-fatal failure. * `Critical` - Not functioning or requiring immediate attention. * `Offline` - Component is installed, but powered off. * `Identifying` - Component is in initialization process. * `NotAvailable` - Component is not installed or not available. * `Updating` - Software update is in progress. * `Unrecognized` - Component is not recognized. It may be because the component is not installed properly or it is not supported. type: string enum: - 'Unknown' - 'Ok' - 'Degraded' - 'Critical' - 'Offline' - 'Identifying' - 'NotAvailable' - 'Updating' - 'Unrecognized' default: Unknown readOnly: true x-omitempty: true Version: description: |- Software version running on a storage controller. type: string readOnly: true x-omitempty: true storage.BaseArrayDisk: title: Storage:Base Array Disk description: |- Common attributes of a storage array disk. x-allOf-name: storage.BaseArrayDisk allOf: - # This 'storage.BaseArrayDisk' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.BaseArrayDisk' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseArrayDisk', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- Disk name available in storage array. type: string readOnly: true x-omitempty: true PartNumber: description: |- Storage disk part number. type: string readOnly: true x-omitempty: true Protocol: description: |- Storage protocol used in disk for communication. Possible values are SAS, SATA and NVMe. * `Unknown` - Disk protocol is unknown. * `SAS` - Serial Attached SCSI protocol (SAS) used in disk. * `NVMe` - Non-volatile memory express (NVMe) protocol used in disk. * `SATA` - Serial Advanced Technology Attachment (SATA) used in disk. type: string enum: - 'Unknown' - 'SAS' - 'NVMe' - 'SATA' default: Unknown readOnly: true x-omitempty: true Speed: description: |- Disk speed for read or write operation measured in rpm. type: integer format: int64 readOnly: true x-omitempty: true Status: description: |- Storage disk health status. * `Unknown` - Component status is not available. * `Ok` - Component is healthy and no issues found. * `Degraded` - Functioning, but not at full capability due to a non-fatal failure. * `Critical` - Not functioning or requiring immediate attention. * `Offline` - Component is installed, but powered off. * `Identifying` - Component is in initialization process. * `NotAvailable` - Component is not installed or not available. * `Updating` - Software update is in progress. * `Unrecognized` - Component is not recognized. It may be because the component is not installed properly or it is not supported. type: string enum: - 'Unknown' - 'Ok' - 'Degraded' - 'Critical' - 'Offline' - 'Identifying' - 'NotAvailable' - 'Updating' - 'Unrecognized' default: Unknown readOnly: true x-omitempty: true StorageUtilization: description: |- Utilization information of the storage disk. $ref: '#/components/schemas/storage.BaseCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Type: description: |- Storage disk type - it can be SSD, HDD, NVRAM. * `Unknown` - Default unknown disk type. * `SSD` - Storage disk with Solid state disk. * `HDD` - Storage disk with Hard disk drive. * `NVRAM` - Storage disk with Non-volatile random-access memory type. * `SATA` - Disk drive implementation with Serial Advanced Technology Attachment (SATA). * `BSAS` - Bridged SAS-SATA disks with added hardware to enable them to be plugged into a SAS-connected storage shelf. * `FC` - Storage disk with Fiber Channel. * `FSAS` - Near Line SAS. NL-SAS drives are enterprise SATA drives with a SAS interface, head, media, androtational speed of traditional enterprise-class SATA drives with the fully capable SAS interfacetypical for classic SAS drives. * `LUN` - Logical Unit Number refers to a logical disk. * `MSATA` - SATA disk in multi-disk carrier storage shelf. * `SAS` - Storage disk with serial attached SCSI. * `VMDISK` - Virtual machine Data Disk. type: string enum: - 'Unknown' - 'SSD' - 'HDD' - 'NVRAM' - 'SATA' - 'BSAS' - 'FC' - 'FSAS' - 'LUN' - 'MSATA' - 'SAS' - 'VMDISK' default: Unknown readOnly: true x-omitempty: true Version: description: |- Storage disk version number. type: string readOnly: true x-omitempty: true storage.BaseCapacity: title: Storage:Base Capacity description: |- Storage capacity information which includes, total capacity, available capacity, used capacity and free capacity. x-allOf-name: storage.BaseCapacity allOf: - # This 'storage.BaseCapacity' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'storage.BaseCapacity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseCapacity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Available: description: |- Total consumable storage capacity represented in bytes. System may reserve some space for internal purposes which is excluded from total capacity. type: integer format: int64 readOnly: true x-omitempty: true CapacityUtilization: description: |- Percentage of used capacity. type: number format: float readOnly: true x-omitempty: true Free: description: |- Unused space available for applications to consume, represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true Total: description: |- Total storage capacity, represented in bytes. It is set by the component manufacturer. type: integer format: int64 readOnly: true x-omitempty: true Used: description: |- Used or consumed storage capacity, represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true storage.BaseHost: title: Storage:Base Host description: |- Generic storage host object. It is a logical object to associate initiators to expose a volume as a LUN. x-allOf-name: storage.BaseHost allOf: - # This 'storage.BaseHost' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseHost' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseHost', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Short description about the host. type: string readOnly: true x-omitempty: true Initiators: type: array items: description: |- List of initiators which are associated with host. $ref: '#/components/schemas/storage.BaseInitiator' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Name: description: |- Name of the host in storage array. type: string readOnly: true x-omitempty: true OsType: description: |- Operating system running on the host. type: string readOnly: true x-omitempty: true StorageUtilization: description: |- Storage utilization of host entity in storage array. $ref: '#/components/schemas/storage.BaseCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true storage.BaseHostGroup: title: Storage:Base Host Group description: |- Generic representation for a group of hosts. x-allOf-name: storage.BaseHostGroup allOf: - # This 'storage.BaseHostGroup' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseHostGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseHostGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Short description about the host group. type: string readOnly: true x-omitempty: true Name: description: |- Name of the host group in storage array. type: string readOnly: true x-omitempty: true StorageUtilization: description: |- Storage utilization of host group entity in storage array. $ref: '#/components/schemas/storage.BaseCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true storage.BaseHostLun: title: Storage:Base Host Lun description: |- Generic storage host lun object. It exists only if the volume is associated to host initiator. x-allOf-name: storage.BaseHostLun allOf: - # This 'storage.BaseHostLun' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseHostLun' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseHostLun', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Hlu: description: |- Logical unit number (LUN) by which hosts address specified volume. Hlu is a decimal representation of the LUN from the endpoint. type: integer format: int64 readOnly: true x-omitempty: true HostName: description: |- Name of the host associated with LUN. type: string readOnly: true x-omitempty: true VolumeName: description: |- Name of the storage volume associated with LUN. type: string readOnly: true x-omitempty: true storage.BaseInitiator: title: Storage:Base Initiator description: |- An initiator is the consumer of storage, typically a server with an adapter card in it called a Host Bus Adapter (HBA). The initiator "initiates" a connection over the fabric to one or more ports on storage system target ports. x-allOf-name: storage.BaseInitiator allOf: - # This 'storage.BaseInitiator' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'storage.BaseInitiator' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseInitiator', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Iqn: description: |- IQN (iSCSI qualified name). Can be up to 255 characters long and has the format iqn.yyyy-mm.naming-authority:unique name. type: string readOnly: true x-omitempty: true Name: description: |- Name of the initiator represented in the storage array. type: string readOnly: true x-omitempty: true Type: description: |- Initiator type, it can be FC or iSCSI. * `FC` - Fibre channel initiator type which contains WWN of an HBA on the host. * `iSCSI` - An iSCSI initiator type which contains the IQN (iSCSI Qualified Name) used by the host. * `Mixed` - Initiator type for systems using both FC and iSCSI connections. type: string enum: - 'FC' - 'iSCSI' - 'Mixed' default: FC readOnly: true x-omitempty: true Wwn: description: |- World wide name, 128 bit address represented in hexadecimal notation. For example, 51:4f:0c:50:14:1f:af:01:51:4f:0c:51:14:1f:af:01. type: string readOnly: true x-omitempty: true storage.BasePhysicalPort: title: Storage:Base Physical Port description: |- Common attributes for a physical port in a storage array. x-allOf-name: storage.BasePhysicalPort allOf: - # This 'storage.BasePhysicalPort' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BasePhysicalPort' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BasePhysicalPort', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Iqn: description: |- ISCSI qualified name applicable for ethernet port. Example - 'iqn.2008-05.com.storage:fnm00151300643-514f0c50141faf05'. type: string readOnly: true x-omitempty: true Name: description: |- Name of the physical port available in storage array. type: string readOnly: true x-omitempty: true Speed: description: |- Operational speed of physical port measured in Gbps. type: integer format: int64 readOnly: true x-omitempty: true Status: description: |- Status of storage array port. * `Unknown` - Component status is not available. * `Ok` - Component is healthy and no issues found. * `Degraded` - Functioning, but not at full capability due to a non-fatal failure. * `Critical` - Not functioning or requiring immediate attention. * `Offline` - Component is installed, but powered off. * `Identifying` - Component is in initialization process. * `NotAvailable` - Component is not installed or not available. * `Updating` - Software update is in progress. * `Unrecognized` - Component is not recognized. It may be because the component is not installed properly or it is not supported. type: string enum: - 'Unknown' - 'Ok' - 'Degraded' - 'Critical' - 'Offline' - 'Identifying' - 'NotAvailable' - 'Updating' - 'Unrecognized' default: Unknown readOnly: true x-omitempty: true Type: description: |- Port type - possible values are FC, FCoE and iSCSI. * `FC` - Port supports fibre channel protocol. * `iSCSI` - Port supports iSCSI protocol. * `FCoE` - Port supports fibre channel over ethernet protocol. type: string enum: - 'FC' - 'iSCSI' - 'FCoE' default: FC readOnly: true x-omitempty: true Wwn: description: |- World wide name of FC port. It is a combination of WWNN and WWPN represented in 128 bit hexadecimal formatted with colon. Example: '51:4f:0c:50:14:1f:af:01:51:4f:0c:51:14:1f:af:01'. type: string readOnly: true x-omitempty: true Wwnn: description: |- World wide node name of FC port. Represented in 64 bit hex digits, formatted with colon. Example - '51:4f:0c:50:14:1f:af:01'. type: string readOnly: true x-omitempty: true Wwpn: description: |- World wide port name of FC port. Represented in 64 bit hex digits, formatted with colon. Example - '51:4f:0c:51:14:1f:af:01'. type: string readOnly: true x-omitempty: true storage.BaseProtectionGroup: title: Storage:Base Protection Group description: |- A protection group contains list of members that are protected together through snapshots with point-in-time consistency across the members. Members within the protection group have common data protection requirements and also the same snapshot, replication, and retention schedules. x-allOf-name: storage.BaseProtectionGroup allOf: - # This 'storage.BaseProtectionGroup' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseProtectionGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseProtectionGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- Name of the protection Group. type: string x-omitempty: true Prefix: description: |- Prefix used for all generated snapshots from the protection group. type: string x-omitempty: true ReplicationEnabled: description: |- Flag to determine if replication is enabled. Snapshots are replicated to the target array if this flag is set. type: boolean x-omitempty: true SnapshotEnabled: description: |- Flag to determine if snapshot creation is enabled. Snapshots are created on local array if this flag is set. type: boolean x-omitempty: true storage.BaseProtectionGroupSnapshot: title: Storage:Base Protection Group Snapshot description: |- Protection group snapshot entity in protection group. x-allOf-name: storage.BaseProtectionGroupSnapshot allOf: - # This 'storage.BaseProtectionGroupSnapshot' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseProtectionGroupSnapshot' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseProtectionGroupSnapshot', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: CreatedTime: description: |- Protection group snapshot creation time. type: string format: date-time readOnly: true x-omitempty: true Name: description: |- Protection group snapshot name which represents point-in-time copy of all members in protection group. type: string readOnly: true x-omitempty: true Size: description: |- Snapshot size represented in bytes. It is a cumulative size of all snapshots in a set. type: integer format: int64 readOnly: true x-omitempty: true Source: description: |- Source protection group name on which the snapshot is created. type: string readOnly: true x-omitempty: true storage.BaseReplicationBlackout: title: Storage:Base Replication Blackout description: |- The range of time during which replication will be suspended. System disables replication during this interval. x-allOf-name: storage.BaseReplicationBlackout allOf: - # This 'storage.BaseReplicationBlackout' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'storage.BaseReplicationBlackout' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseReplicationBlackout', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: End: description: |- The end time of day for replication blackout window. Example: 17:00:01 which is 17 hours, 0 minutes, 1 seconds. type: string format: time readOnly: true x-omitempty: true Start: description: |- The start time of day when replication blackout is active. When replication blackout is active, the storage array temporarily disables replication. Example: 15:04:03.123 which is 15 hours, 4 minutes, 3 seconds and 123 milliseconds. The fractional seconds are written using the standard decimal notation which can be used for setting milliseconds and microseconds. type: string format: time readOnly: true x-omitempty: true storage.BaseReplicationSchedule: title: Storage:Base Replication Schedule description: |- Configuration parameters for snapshot creation on target arrays. x-allOf-name: storage.BaseReplicationSchedule allOf: - # This 'storage.BaseReplicationSchedule' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseReplicationSchedule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseReplicationSchedule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Frequency: description: |- Replication frequency. It is an interval at which replication is set to trigger. Examples: PT2H, Snapshot is generated every 2 hours. P30D, Snapshot is scheduled for every 30 days. PT2H34M56.123S is 2 hours, 34 minutes, 56 seconds and 123 milliseconds. type: string readOnly: true x-omitempty: true Name: description: |- Replication schedule name. type: string readOnly: true x-omitempty: true ReplicationTime: description: |- Preferred time of day at which to replicate the snapshots on target array. It is applicable only if the replication frequency is set for a day or more. Format: hh:mm:ss Example: 15:00:00, Replication is set for 3:00 PM. type: string format: time readOnly: true x-omitempty: true RetentionTime: description: |- Duration to keep the replicated snapshots on the targets. Replicated snapshots are deleted from target array once the retention period has elapsed. Examples: P30D, Snapshots are available for 30 days. PT2H34M56.123S, 2 hours, 34 minutes, 56 seconds and 123 milliseconds. type: string readOnly: true x-omitempty: true storage.BaseSnapshot: title: Storage:Base Snapshot description: |- Reference marker for volume. It is a point-in-time copy of the volume. x-allOf-name: storage.BaseSnapshot allOf: - # This 'storage.BaseSnapshot' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseSnapshot' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseSnapshot', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: CreatedTime: description: |- Exact date and time at which snapshot was created. type: string format: date-time readOnly: true x-omitempty: true Name: description: |- Name of the snapshot which represents point-in-time copy of volume. type: string readOnly: true x-omitempty: true ProtectionGroupName: description: |- Name of the protection group to which the snapshot belongs. Value is empty, if the snapshot is created directly on volume. type: string readOnly: true x-omitempty: true Size: description: |- Snapshot size represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true Source: description: |- Source object on which the snapshot is created. It is the name of the originating volume. type: string readOnly: true x-omitempty: true storage.BaseSnapshotSchedule: title: Storage:Base Snapshot Schedule description: |- Configuration parameters for snapshot creation at source array. x-allOf-name: storage.BaseSnapshotSchedule allOf: - # This 'storage.BaseSnapshotSchedule' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseSnapshotSchedule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseSnapshotSchedule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Frequency: description: |- Snapshot frequency. It is an interval at which snapshot is set to trigger on source array. Examples: PT2H Snapshot is generated every 2 hours. P4D, Snapshot is scheduled for every 4 days. PT2H34M56.123S is 2 hours, 34 minutes, 56 seconds and 123 milliseconds. type: string readOnly: true x-omitempty: true Name: description: |- Name of the snapshot schedule. type: string x-omitempty: true RetentionTime: description: |- Duration to keep the snapshots on the source array. Once this period expires, system deletes the snapshot automatically from the source array. Examples: P200D, 200 days. PT2H34M56.123S, 2 hours, 34 minutes, 56 seconds and 123 milliseconds. type: string readOnly: true x-omitempty: true SnapshotTime: description: |- Preferred time of the day to capture the snapshot. It is applicable only if the frequency is set for a day or more. Format: hh:mm:ss Example: 08:30:00, Snapshot is set for 08:30 AM. type: string format: time readOnly: true x-omitempty: true storage.BaseVolume: title: Storage:Base Volume description: |- Generic storage volume object. It is a provisioned storage identity which can be mapped to host to enable host access. x-allOf-name: storage.BaseVolume allOf: - # This 'storage.BaseVolume' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'storage.BaseVolume' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.BaseVolume', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Short description about the volume. type: string readOnly: true x-omitempty: true NaaId: description: |- NAA id of volume. It is a significant number to identify corresponding lun path in hypervisor. type: string readOnly: true x-omitempty: true Name: description: |- Named entity of the volume. type: string readOnly: true x-omitempty: true Size: description: |- User provisioned volume size. It is the size exposed to host. type: integer format: int64 readOnly: true x-omitempty: true StorageUtilization: description: |- Storage utilization of volume entity in storage array. $ref: '#/components/schemas/storage.BaseCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true storage.Controller.Response: description: |- The response body of a HTTP GET request for the 'storage.Controller' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.Controller' resources. x-one-of-name: storage.Controller.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.Controller.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.Controller.Relationship: description: A relationship to the 'storage.Controller' resource, or the expanded 'storage.Controller' resource, or the 'null' value. x-one-of-name: storage.Controller.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.Controller' storage.Controller: title: Storage:Controller description: |- Storage Controller present in a server. x-allOf-name: storage.Controller allOf: - # This 'storage.Controller' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.Controller' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.Controller', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.Controller' ObjectType: enum: - 'storage.Controller' ControllerFlags: description: |- The flags for the storage controller. type: string readOnly: true x-omitempty: true ControllerId: description: |- The Id of the storage controller. type: string readOnly: true x-omitempty: true ControllerStatus: description: |- The current status of controller. type: string readOnly: true x-omitempty: true ForeignConfigPresent: description: |- Storage controller has detected disks in foreign config. type: boolean x-omitempty: true HwRevision: description: |- The hardware revision of controller. type: string readOnly: true x-omitempty: true InterfaceType: description: |- Interface types are Sas, Sata, PCH. type: string x-omitempty: true MaxVolumesSupported: description: |- Maximum virtual drives that can be created on this Storage Controller. type: integer format: int64 x-omitempty: true OobInterfaceSupported: description: |- The CIMC support for out-of-band configuration of controller. type: string readOnly: true x-omitempty: true OperState: description: |- The current operational state of controller. type: string readOnly: true x-omitempty: true Operability: description: |- Operability state of the storage controller. type: string readOnly: true x-omitempty: true PciAddr: description: |- The current pci address of controller. type: string readOnly: true x-omitempty: true PciSlot: description: |- The pci slot name for the controller. type: string readOnly: true x-omitempty: true Presence: description: |- Physical Presence State for the Storage Controller. type: string readOnly: true x-omitempty: true RaidSupport: description: |- The RAID levels supported by controller. type: string readOnly: true x-omitempty: true RebuildRate: description: |- Logical volume or RAID rebuild rate of Storage Controller. type: string readOnly: true x-omitempty: true SelfEncryptEnabled: description: |- Storage controller disk self encryption state. type: string x-omitempty: true Type: description: |- Controller types are Raid, FlexFlash. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. DiskGroup: # A Relationship to MO storage.DiskGroup description: An array of relationships to storageDiskGroup resources. type: array items: $ref: '#/components/schemas/storage.DiskGroup.Relationship' nullable: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalDiskExtensions: # A Relationship to MO storage.PhysicalDiskExtension description: An array of relationships to storagePhysicalDiskExtension resources. type: array items: $ref: '#/components/schemas/storage.PhysicalDiskExtension.Relationship' nullable: true readOnly: true PhysicalDisks: # A Relationship to MO storage.PhysicalDisk description: An array of relationships to storagePhysicalDisk resources. type: array items: $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningFirmware: # A Relationship to MO firmware.RunningFirmware description: An array of relationships to firmwareRunningFirmware resources. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' nullable: true readOnly: true VirtualDriveExtensions: # A Relationship to MO storage.VirtualDriveExtension description: An array of relationships to storageVirtualDriveExtension resources. type: array items: $ref: '#/components/schemas/storage.VirtualDriveExtension.Relationship' nullable: true readOnly: true VirtualDrives: # A Relationship to MO storage.VirtualDrive description: An array of relationships to storageVirtualDrive resources. type: array items: $ref: '#/components/schemas/storage.VirtualDrive.Relationship' nullable: true readOnly: true storage.Controller.List: title: List of 'storage.Controller' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.Controller' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.Controller' resources matching the request. type: array items: $ref: '#/components/schemas/storage.Controller' nullable: true storage.DiskGroup.Response: description: |- The response body of a HTTP GET request for the 'storage.DiskGroup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.DiskGroup' resources. x-one-of-name: storage.DiskGroup.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.DiskGroup.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.DiskGroup.Relationship: description: A relationship to the 'storage.DiskGroup' resource, or the expanded 'storage.DiskGroup' resource, or the 'null' value. x-one-of-name: storage.DiskGroup.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.DiskGroup' storage.DiskGroup: title: Storage:Disk Group description: |- Group of one or more Spans to configure virtual drive. x-allOf-name: storage.DiskGroup allOf: - # This 'storage.DiskGroup' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.DiskGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.DiskGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.DiskGroup' ObjectType: enum: - 'storage.DiskGroup' Name: description: |- Name to identity this disk group in the controller. type: string x-omitempty: true RaidType: description: |- Raid level of the virtual drives in this diskgroup. type: string x-omitempty: true DedicatedHotSpares: # A Relationship to MO storage.PhysicalDisk description: An array of relationships to storagePhysicalDisk resources. type: array items: $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' nullable: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Spans: # A Relationship to MO storage.Span description: An array of relationships to storageSpan resources. type: array items: $ref: '#/components/schemas/storage.Span.Relationship' nullable: true StorageController: # A Relationship to MO storage.Controller $ref: '#/components/schemas/storage.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageController resource. When the $expand query parameter is specified, the referenced resource is returned inline. VirtualDrives: # A Relationship to MO storage.VirtualDrive description: An array of relationships to storageVirtualDrive resources. type: array items: $ref: '#/components/schemas/storage.VirtualDrive.Relationship' nullable: true storage.DiskGroup.List: title: List of 'storage.DiskGroup' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.DiskGroup' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.DiskGroup' resources matching the request. type: array items: $ref: '#/components/schemas/storage.DiskGroup' nullable: true storage.DiskGroupPolicy.Response: description: |- The response body of a HTTP GET request for the 'storage.DiskGroupPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.DiskGroupPolicy' resources. x-one-of-name: storage.DiskGroupPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.DiskGroupPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.DiskGroupPolicy.Relationship: description: A relationship to the 'storage.DiskGroupPolicy' resource, or the expanded 'storage.DiskGroupPolicy' resource, or the 'null' value. x-one-of-name: storage.DiskGroupPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.DiskGroupPolicy' storage.DiskGroupPolicy: title: Disk Group description: |- A reusable RAID disk group configuration that can be applied across multiple servers. Also provides options to move JBOD disks in the disk group to Unconfigured Good state before they are used in the disk group. x-allOf-name: storage.DiskGroupPolicy allOf: - # This 'storage.DiskGroupPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'storage.DiskGroupPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.DiskGroupPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.DiskGroupPolicy' ObjectType: enum: - 'storage.DiskGroupPolicy' DedicatedHotSpares: type: array items: description: |- A collection of disks used as hot spares for this RAID group. $ref: '#/components/schemas/storage.LocalDisk' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true RaidLevel: description: |- The supported RAID level for the disk group. * `Raid0` - RAID 0 Stripe Raid Level. * `Raid1` - RAID 1 Mirror Raid Level. * `Raid5` - RAID 5 Mirror Raid Level. * `Raid6` - RAID 6 Mirror Raid Level. * `Raid10` - RAID 10 Mirror Raid Level. * `Raid50` - RAID 50 Mirror Raid Level. * `Raid60` - RAID 60 Mirror Raid Level. type: string enum: - 'Raid0' - 'Raid1' - 'Raid5' - 'Raid6' - 'Raid10' - 'Raid50' - 'Raid60' default: Raid0 x-omitempty: true SpanGroups: type: array items: description: |- Non spanned RAID levels like Raid0, Raid1, Raid5 and Raid6 expect a single group of disks whereas spanned RAID levels need multiple groups of disks with each group representing a span group. Non spanned RAID levels expect one span group and spanned RAID levels accept minimum 2 span groups and up to 8. $ref: '#/components/schemas/storage.SpanGroup' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true UseJbods: description: |- Selected disks in the disk group in JBOD state will be set to Unconfigured Good state before they are used in virtual drive creation. type: boolean x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true StoragePolicies: # A Relationship to MO storage.StoragePolicy description: An array of relationships to storageStoragePolicy resources. type: array items: $ref: '#/components/schemas/storage.StoragePolicy.Relationship' nullable: true storage.DiskGroupPolicy.List: title: List of 'storage.DiskGroupPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.DiskGroupPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.DiskGroupPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/storage.DiskGroupPolicy' nullable: true storage.Enclosure.Response: description: |- The response body of a HTTP GET request for the 'storage.Enclosure' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.Enclosure' resources. x-one-of-name: storage.Enclosure.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.Enclosure.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.Enclosure.Relationship: description: A relationship to the 'storage.Enclosure' resource, or the expanded 'storage.Enclosure' resource, or the 'null' value. x-one-of-name: storage.Enclosure.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.Enclosure' storage.Enclosure: title: Storage:Enclosure description: |- Storage Enclosure for physical disks. x-allOf-name: storage.Enclosure allOf: - # This 'storage.Enclosure' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.Enclosure' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.Enclosure', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.Enclosure' ObjectType: enum: - 'storage.Enclosure' ChassisId: description: |- This represent the chassis-ID that houses the storage enclosure. type: integer format: int64 readOnly: true x-omitempty: true Description: description: |- This represnets the description for the storage enclosure. type: string readOnly: true x-omitempty: true EnclosureId: description: |- This represnets the Identifier for the storage enclosure. type: integer format: int64 readOnly: true x-omitempty: true NumSlots: description: |- This represent the number of slots present in storage enclosure. type: integer format: int64 readOnly: true x-omitempty: true Presence: description: |- This represent the availability of storage enclosure. type: string readOnly: true x-omitempty: true ServerId: description: |- This represent the server-ID that houses the storage enclosure. type: integer format: int64 readOnly: true x-omitempty: true Type: description: |- This represent the type of storage enclosure. type: string readOnly: true x-omitempty: true ComputeBlade: # A Relationship to MO compute.Blade $ref: '#/components/schemas/compute.Blade.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBlade resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EnclosureDiskSlots: # A Relationship to MO storage.EnclosureDiskSlotEp description: An array of relationships to storageEnclosureDiskSlotEp resources. type: array items: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp.Relationship' nullable: true readOnly: true EnclosureDisks: # A Relationship to MO storage.EnclosureDisk description: An array of relationships to storageEnclosureDisk resources. type: array items: $ref: '#/components/schemas/storage.EnclosureDisk.Relationship' nullable: true readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalDisks: # A Relationship to MO storage.PhysicalDisk description: An array of relationships to storagePhysicalDisk resources. type: array items: $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.Enclosure.List: title: List of 'storage.Enclosure' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.Enclosure' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.Enclosure' resources matching the request. type: array items: $ref: '#/components/schemas/storage.Enclosure' nullable: true storage.EnclosureDisk.Response: description: |- The response body of a HTTP GET request for the 'storage.EnclosureDisk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.EnclosureDisk' resources. x-one-of-name: storage.EnclosureDisk.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.EnclosureDisk.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.EnclosureDisk.Relationship: description: A relationship to the 'storage.EnclosureDisk' resource, or the expanded 'storage.EnclosureDisk' resource, or the 'null' value. x-one-of-name: storage.EnclosureDisk.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.EnclosureDisk' storage.EnclosureDisk: title: Storage:Enclosure Disk description: |- Physical Disk on the enclosure. x-allOf-name: storage.EnclosureDisk allOf: - # This 'storage.EnclosureDisk' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.EnclosureDisk' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.EnclosureDisk', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.EnclosureDisk' ObjectType: enum: - 'storage.EnclosureDisk' BlockSize: description: |- The block size of the physical disk in bytes. type: string x-omitempty: true DiskId: description: |- This field represents the disk Id in the storage enclosure. type: string x-omitempty: true DiskState: description: |- This field identifies the current disk configuration applied in the physical disk. type: string x-omitempty: true Health: description: |- The current health state of the enclosure disk. type: string x-omitempty: true NumBlocks: description: |- The number of blocks present on the physical disk. type: string x-omitempty: true Pid: description: |- This field identifies the Product ID for physicalDisk. type: string readOnly: true x-omitempty: true SasAddress1: description: |- This field identifies the SAS address assigned to the disk SAS port-1. type: string x-omitempty: true SasAddress2: description: |- This field identifies the SAS address assigned to the disk SAS port-2. type: string x-omitempty: true Size: description: |- The size of the physical disk in MB. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalDisk: # A Relationship to MO storage.PhysicalDisk $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePhysicalDisk resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageEnclosure: # A Relationship to MO storage.Enclosure $ref: '#/components/schemas/storage.Enclosure.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageEnclosure resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.EnclosureDisk.List: title: List of 'storage.EnclosureDisk' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.EnclosureDisk' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.EnclosureDisk' resources matching the request. type: array items: $ref: '#/components/schemas/storage.EnclosureDisk' nullable: true storage.EnclosureDiskSlotEp.Response: description: |- The response body of a HTTP GET request for the 'storage.EnclosureDiskSlotEp' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.EnclosureDiskSlotEp' resources. x-one-of-name: storage.EnclosureDiskSlotEp.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.EnclosureDiskSlotEp.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.EnclosureDiskSlotEp.Relationship: description: A relationship to the 'storage.EnclosureDiskSlotEp' resource, or the expanded 'storage.EnclosureDiskSlotEp' resource, or the 'null' value. x-one-of-name: storage.EnclosureDiskSlotEp.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.EnclosureDiskSlotEp' storage.EnclosureDiskSlotEp: title: Storage:Enclosure Disk Slot Ep description: |- Physical Disk slots on the enclosure. x-allOf-name: storage.EnclosureDiskSlotEp allOf: - # This 'storage.EnclosureDiskSlotEp' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.EnclosureDiskSlotEp' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.EnclosureDiskSlotEp', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.EnclosureDiskSlotEp' ObjectType: enum: - 'storage.EnclosureDiskSlotEp' DrivePath: description: |- This field identifies the zoning configuration applied to this enclosure slot. type: string x-omitempty: true Health: description: |- This field identifies the health of the disk inserted in the slot. type: string x-omitempty: true Presence: description: |- This field identifies the disk is present in the enclosure slot. type: string x-omitempty: true Slot: description: |- This field represents the slot Id in the storage enclosure. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageEnclosure: # A Relationship to MO storage.Enclosure $ref: '#/components/schemas/storage.Enclosure.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageEnclosure resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.EnclosureDiskSlotEp.List: title: List of 'storage.EnclosureDiskSlotEp' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.EnclosureDiskSlotEp' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.EnclosureDiskSlotEp' resources matching the request. type: array items: $ref: '#/components/schemas/storage.EnclosureDiskSlotEp' nullable: true storage.FlexFlashController.Response: description: |- The response body of a HTTP GET request for the 'storage.FlexFlashController' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.FlexFlashController' resources. x-one-of-name: storage.FlexFlashController.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.FlexFlashController.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.FlexFlashController.Relationship: description: A relationship to the 'storage.FlexFlashController' resource, or the expanded 'storage.FlexFlashController' resource, or the 'null' value. x-one-of-name: storage.FlexFlashController.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.FlexFlashController' storage.FlexFlashController: title: Storage:Flex Flash Controller description: |- Storage Flex Flash Controller. x-allOf-name: storage.FlexFlashController allOf: - # This 'storage.FlexFlashController' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.FlexFlashController' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.FlexFlashController', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.FlexFlashController' ObjectType: enum: - 'storage.FlexFlashController' ControllerState: description: |- State of the Flex Flash Storage Controller. type: string readOnly: true x-omitempty: true FfControllerId: description: |- Identifier for the Flex Flash Storage Controller. type: string readOnly: true x-omitempty: true ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true FlexFlashControllerProps: # A Relationship to MO storage.FlexFlashControllerProps description: An array of relationships to storageFlexFlashControllerProps resources. type: array items: $ref: '#/components/schemas/storage.FlexFlashControllerProps.Relationship' nullable: true readOnly: true FlexFlashPhysicalDrives: # A Relationship to MO storage.FlexFlashPhysicalDrive description: An array of relationships to storageFlexFlashPhysicalDrive resources. type: array items: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive.Relationship' nullable: true readOnly: true FlexFlashVirtualDrives: # A Relationship to MO storage.FlexFlashVirtualDrive description: An array of relationships to storageFlexFlashVirtualDrive resources. type: array items: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningFirmware: # A Relationship to MO firmware.RunningFirmware description: An array of relationships to firmwareRunningFirmware resources. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' nullable: true readOnly: true storage.FlexFlashController.List: title: List of 'storage.FlexFlashController' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.FlexFlashController' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.FlexFlashController' resources matching the request. type: array items: $ref: '#/components/schemas/storage.FlexFlashController' nullable: true storage.FlexFlashControllerProps.Response: description: |- The response body of a HTTP GET request for the 'storage.FlexFlashControllerProps' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.FlexFlashControllerProps' resources. x-one-of-name: storage.FlexFlashControllerProps.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.FlexFlashControllerProps.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.FlexFlashControllerProps.Relationship: description: A relationship to the 'storage.FlexFlashControllerProps' resource, or the expanded 'storage.FlexFlashControllerProps' resource, or the 'null' value. x-one-of-name: storage.FlexFlashControllerProps.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.FlexFlashControllerProps' storage.FlexFlashControllerProps: title: Storage:Flex Flash Controller Props description: |- Flex flash controller properties. x-allOf-name: storage.FlexFlashControllerProps allOf: - # This 'storage.FlexFlashControllerProps' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.FlexFlashControllerProps' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.FlexFlashControllerProps', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.FlexFlashControllerProps' ObjectType: enum: - 'storage.FlexFlashControllerProps' CardsManageable: description: |- Manageable card on the flex flash controller. type: string x-omitempty: true ConfiguredMode: description: |- Mode configured on the flex flash controller. type: string x-omitempty: true ControllerName: description: |- The current name of the flex flash controller. type: string x-omitempty: true ControllerStatus: description: |- The current status of the flex flash controller. type: string x-omitempty: true FwVersion: description: |- Firmware version of the flex flash controller. type: string x-omitempty: true InternalState: description: |- Internal state of the flex flash controller. type: string x-omitempty: true OperatingMode: description: |- Operating mode of flex flash controller. type: string x-omitempty: true PhysicalDriveCount: description: |- Number of connected physical drives to a specific Flex flash controller. type: string x-omitempty: true ProductName: description: |- Product name of the flex flash controller. type: string x-omitempty: true StartupFwVersion: description: |- Startup firmware version of the Flex flash controller. type: string x-omitempty: true VirtualDriveCount: description: |- Number of virtual drives for a specific Flex flash controller. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageFlexFlashController: # A Relationship to MO storage.FlexFlashController $ref: '#/components/schemas/storage.FlexFlashController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageFlexFlashController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.FlexFlashControllerProps.List: title: List of 'storage.FlexFlashControllerProps' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.FlexFlashControllerProps' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.FlexFlashControllerProps' resources matching the request. type: array items: $ref: '#/components/schemas/storage.FlexFlashControllerProps' nullable: true storage.FlexFlashPhysicalDrive.Response: description: |- The response body of a HTTP GET request for the 'storage.FlexFlashPhysicalDrive' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.FlexFlashPhysicalDrive' resources. x-one-of-name: storage.FlexFlashPhysicalDrive.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.FlexFlashPhysicalDrive.Relationship: description: A relationship to the 'storage.FlexFlashPhysicalDrive' resource, or the expanded 'storage.FlexFlashPhysicalDrive' resource, or the 'null' value. x-one-of-name: storage.FlexFlashPhysicalDrive.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive' storage.FlexFlashPhysicalDrive: title: Storage:Flex Flash Physical Drive description: |- Physical Drive repersenting a SD Card. x-allOf-name: storage.FlexFlashPhysicalDrive allOf: - # This 'storage.FlexFlashPhysicalDrive' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.FlexFlashPhysicalDrive' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.FlexFlashPhysicalDrive', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.FlexFlashPhysicalDrive' ObjectType: enum: - 'storage.FlexFlashPhysicalDrive' CardStatus: description: |- The status of the flex flash physical drive. type: string x-omitempty: true CardType: description: |- The card type of the flex flash physical drive. type: string x-omitempty: true OemId: description: |- The OEM Identifier of the flex flash physical drive. type: string x-omitempty: true PdStatus: description: |- The drive status of the flex flash physical drive. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageFlexFlashController: # A Relationship to MO storage.FlexFlashController $ref: '#/components/schemas/storage.FlexFlashController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageFlexFlashController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.FlexFlashPhysicalDrive.List: title: List of 'storage.FlexFlashPhysicalDrive' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.FlexFlashPhysicalDrive' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.FlexFlashPhysicalDrive' resources matching the request. type: array items: $ref: '#/components/schemas/storage.FlexFlashPhysicalDrive' nullable: true storage.FlexFlashVirtualDrive.Response: description: |- The response body of a HTTP GET request for the 'storage.FlexFlashVirtualDrive' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.FlexFlashVirtualDrive' resources. x-one-of-name: storage.FlexFlashVirtualDrive.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.FlexFlashVirtualDrive.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.FlexFlashVirtualDrive.Relationship: description: A relationship to the 'storage.FlexFlashVirtualDrive' resource, or the expanded 'storage.FlexFlashVirtualDrive' resource, or the 'null' value. x-one-of-name: storage.FlexFlashVirtualDrive.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.FlexFlashVirtualDrive' storage.FlexFlashVirtualDrive: title: Storage:Flex Flash Virtual Drive description: |- Virtual Drive repersenting a SD Card. x-allOf-name: storage.FlexFlashVirtualDrive allOf: - # This 'storage.FlexFlashVirtualDrive' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.FlexFlashVirtualDrive' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.FlexFlashVirtualDrive', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.FlexFlashVirtualDrive' ObjectType: enum: - 'storage.FlexFlashVirtualDrive' DriveScope: description: |- The drive scope of the flex flash virtual drive. type: string x-omitempty: true DriveStatus: description: |- Status of virtual drive on the flex controller. type: string x-omitempty: true PartitionId: description: |- The partition Id of the flex flash virtual Drive. type: string x-omitempty: true ResidentImage: description: |- The resident image on the flex flash virtual Drive. type: string x-omitempty: true Size: description: |- Size of virtual drive on the flex controller. type: string x-omitempty: true VirtualDrive: description: |- Virtual drive on the flex flash controller. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageFlexFlashController: # A Relationship to MO storage.FlexFlashController $ref: '#/components/schemas/storage.FlexFlashController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageFlexFlashController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.FlexFlashVirtualDrive.List: title: List of 'storage.FlexFlashVirtualDrive' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.FlexFlashVirtualDrive' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.FlexFlashVirtualDrive' resources matching the request. type: array items: $ref: '#/components/schemas/storage.FlexFlashVirtualDrive' nullable: true storage.FlexUtilController.Response: description: |- The response body of a HTTP GET request for the 'storage.FlexUtilController' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.FlexUtilController' resources. x-one-of-name: storage.FlexUtilController.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.FlexUtilController.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.FlexUtilController.Relationship: description: A relationship to the 'storage.FlexUtilController' resource, or the expanded 'storage.FlexUtilController' resource, or the 'null' value. x-one-of-name: storage.FlexUtilController.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.FlexUtilController' storage.FlexUtilController: title: Storage:Flex Util Controller description: |- Storage Flex Util Adapter. x-allOf-name: storage.FlexUtilController allOf: - # This 'storage.FlexUtilController' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.FlexUtilController' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.FlexUtilController', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.FlexUtilController' ObjectType: enum: - 'storage.FlexUtilController' ControllerName: description: |- Name of the Flex Util Controller. type: string x-omitempty: true ControllerStatus: description: |- The current status of the controller. type: string x-omitempty: true FfControllerId: description: |- Identifier for the Storage Flex Util Controller. type: string x-omitempty: true InternalState: description: |- The internal state of the controller. type: string x-omitempty: true ComputeBoard: # A Relationship to MO compute.Board $ref: '#/components/schemas/compute.Board.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeBoard resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true FlexUtilPhysicalDrives: # A Relationship to MO storage.FlexUtilPhysicalDrive description: An array of relationships to storageFlexUtilPhysicalDrive resources. type: array items: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive.Relationship' nullable: true readOnly: true FlexUtilVirtualDrives: # A Relationship to MO storage.FlexUtilVirtualDrive description: An array of relationships to storageFlexUtilVirtualDrive resources. type: array items: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.FlexUtilController.List: title: List of 'storage.FlexUtilController' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.FlexUtilController' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.FlexUtilController' resources matching the request. type: array items: $ref: '#/components/schemas/storage.FlexUtilController' nullable: true storage.FlexUtilPhysicalDrive.Response: description: |- The response body of a HTTP GET request for the 'storage.FlexUtilPhysicalDrive' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.FlexUtilPhysicalDrive' resources. x-one-of-name: storage.FlexUtilPhysicalDrive.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.FlexUtilPhysicalDrive.Relationship: description: A relationship to the 'storage.FlexUtilPhysicalDrive' resource, or the expanded 'storage.FlexUtilPhysicalDrive' resource, or the 'null' value. x-one-of-name: storage.FlexUtilPhysicalDrive.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive' storage.FlexUtilPhysicalDrive: title: Storage:Flex Util Physical Drive description: |- Storage Flex Util Physical Drive. x-allOf-name: storage.FlexUtilPhysicalDrive allOf: - # This 'storage.FlexUtilPhysicalDrive' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.FlexUtilPhysicalDrive' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.FlexUtilPhysicalDrive', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.FlexUtilPhysicalDrive' ObjectType: enum: - 'storage.FlexUtilPhysicalDrive' BlockSize: description: |- Block size of the FlexUtil Physical drive. type: string x-omitempty: true Capacity: description: |- Capacity of the FlexUtil Physical drive. type: string x-omitempty: true Controller: description: |- Type of the Physical Drive Controller. type: string x-omitempty: true DrivesEnabled: description: |- The number of drives enabled in the FlexUtil Physical Drive. type: string x-omitempty: true Health: description: |- Health of the FlexUtil Physical drive. type: string x-omitempty: true ManufacturerDate: description: |- Manufacturing date of the FlexUtil Physical Drive. type: string x-omitempty: true ManufacturerId: description: |- Manufacturer identity of the FlexUtil Physical Drive. type: string x-omitempty: true OemId: description: |- The OEM Identifier of the FlexUtil physical drive. type: string x-omitempty: true PartitionCount: description: |- The number of partitions present on the FlexUtil Physical Drive. type: string x-omitempty: true PdStatus: description: |- Status of the FlexUtil Physical Drive. type: string x-omitempty: true PhysicalDrive: description: |- The type of physical drive. Example - microSD. type: string x-omitempty: true ProductName: description: |- Product name of the FlexUtil Physical Drive. type: string x-omitempty: true ProductRevision: description: |- Product revision of the FlexUtil Physical Drive. type: string x-omitempty: true ReadErrorCount: description: |- Read error count of the FlexUtil Physical Drive. type: string x-omitempty: true ReadErrorThreshold: description: |- Read error threshold for FlexUtil Physical Drive. type: string x-omitempty: true WriteEnabled: description: |- Write access state of the FlexUtil Physical Drive. type: string x-omitempty: true WriteErrorCount: description: |- Write error count of the FlexUtil Physical Drive. type: string x-omitempty: true WriteErrorThreshold: description: |- Write error threshold for FlexUtil Physical Drive. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageFlexUtilController: # A Relationship to MO storage.FlexUtilController $ref: '#/components/schemas/storage.FlexUtilController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageFlexUtilController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.FlexUtilPhysicalDrive.List: title: List of 'storage.FlexUtilPhysicalDrive' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.FlexUtilPhysicalDrive' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.FlexUtilPhysicalDrive' resources matching the request. type: array items: $ref: '#/components/schemas/storage.FlexUtilPhysicalDrive' nullable: true storage.FlexUtilVirtualDrive.Response: description: |- The response body of a HTTP GET request for the 'storage.FlexUtilVirtualDrive' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.FlexUtilVirtualDrive' resources. x-one-of-name: storage.FlexUtilVirtualDrive.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.FlexUtilVirtualDrive.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.FlexUtilVirtualDrive.Relationship: description: A relationship to the 'storage.FlexUtilVirtualDrive' resource, or the expanded 'storage.FlexUtilVirtualDrive' resource, or the 'null' value. x-one-of-name: storage.FlexUtilVirtualDrive.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.FlexUtilVirtualDrive' storage.FlexUtilVirtualDrive: title: Storage:Flex Util Virtual Drive description: |- Storage Flex Util Virtual Drive. x-allOf-name: storage.FlexUtilVirtualDrive allOf: - # This 'storage.FlexUtilVirtualDrive' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.FlexUtilVirtualDrive' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.FlexUtilVirtualDrive', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.FlexUtilVirtualDrive' ObjectType: enum: - 'storage.FlexUtilVirtualDrive' DriveStatus: description: |- Status of the Flex Util virtual drive. type: string x-omitempty: true DriveType: description: |- Type of virtual drive managed by flex util controller. type: string x-omitempty: true PartitionId: description: |- Disk Partition Id of virtual drive managed by flex util controller. type: string x-omitempty: true PartitionName: description: |- Partition name of the Flex Util virtual drive. type: string x-omitempty: true ResidentImage: description: |- The resident image on the flex util virtual Drive. type: string x-omitempty: true Size: description: |- Size of the Flex Util virtual drive. type: string x-omitempty: true VirtualDrive: description: |- Virtual drive on the Flex Util controller. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageFlexUtilController: # A Relationship to MO storage.FlexUtilController $ref: '#/components/schemas/storage.FlexUtilController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageFlexUtilController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.FlexUtilVirtualDrive.List: title: List of 'storage.FlexUtilVirtualDrive' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.FlexUtilVirtualDrive' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.FlexUtilVirtualDrive' resources matching the request. type: array items: $ref: '#/components/schemas/storage.FlexUtilVirtualDrive' nullable: true storage.Initiator: title: Storage:Initiator description: |- An initiator is the consumer of storage, typically a server with an adapter card in it called a Host Bus Adapter (HBA). The initiator "initiates" a connection over the fabric to one or more ports on storage system target ports. x-allOf-name: storage.Initiator allOf: - # This 'storage.Initiator' class inherits all properties from its parent class storage.BaseInitiator. $ref: '#/components/schemas/storage.BaseInitiator' storage.Item.Response: description: |- The response body of a HTTP GET request for the 'storage.Item' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.Item' resources. x-one-of-name: storage.Item.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.Item.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.Item.Relationship: description: A relationship to the 'storage.Item' resource, or the expanded 'storage.Item' resource, or the 'null' value. x-one-of-name: storage.Item.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.Item' storage.Item: title: Storage:Item description: |- FI Local Storage information. x-allOf-name: storage.Item allOf: - # This 'storage.Item' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.Item' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.Item', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.Item' ObjectType: enum: - 'storage.Item' AlarmType: description: |- The alarmType of the Local storage in FI. type: string readOnly: true x-omitempty: true Name: description: |- The name of the Local storage in FI. type: string readOnly: true x-omitempty: true OperState: description: |- The operState of the Local storage in FI. type: string readOnly: true x-omitempty: true Size: description: |- The size (MB) of the Local storage in FI. type: string readOnly: true x-omitempty: true Used: description: |- The used percent of the Local storage in FI. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElement: # A Relationship to MO network.Element $ref: '#/components/schemas/network.Element.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a networkElement resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.Item.List: title: List of 'storage.Item' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.Item' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.Item' resources matching the request. type: array items: $ref: '#/components/schemas/storage.Item' nullable: true storage.LocalDisk: title: Storage:Local Disk description: |- This models disks in the disk group. x-allOf-name: storage.LocalDisk allOf: - # This 'storage.LocalDisk' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'storage.LocalDisk' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.LocalDisk', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.LocalDisk' ObjectType: enum: - 'storage.LocalDisk' SlotNumber: description: |- The slot number of the disk to be referenced. As this is a policy, this slot number may or may not be valid depending on the number of disks in the associated server. type: integer format: int64 minimum: 1 maximum: 254 x-omitempty: true storage.PhysicalDisk.Response: description: |- The response body of a HTTP GET request for the 'storage.PhysicalDisk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PhysicalDisk' resources. x-one-of-name: storage.PhysicalDisk.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PhysicalDisk.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PhysicalDisk.Relationship: description: A relationship to the 'storage.PhysicalDisk' resource, or the expanded 'storage.PhysicalDisk' resource, or the 'null' value. x-one-of-name: storage.PhysicalDisk.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PhysicalDisk' storage.PhysicalDisk: title: Storage:Physical Disk description: |- Physical Disk on a server. x-allOf-name: storage.PhysicalDisk allOf: - # This 'storage.PhysicalDisk' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.PhysicalDisk' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PhysicalDisk', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PhysicalDisk' ObjectType: enum: - 'storage.PhysicalDisk' BlockSize: description: |- The block size of the physical disk in bytes. type: string readOnly: true x-omitempty: true Bootable: description: |- This field identifies the disk drive as bootable if set to true. type: string readOnly: true x-omitempty: true ConfigurationCheckpoint: description: |- The current configuration checkpoint of the physical disk. type: string readOnly: true x-omitempty: true ConfigurationState: description: |- The current configuration state of the physical disk. type: string readOnly: true x-omitempty: true DiscoveredPath: description: |- The discovered path of the physical disk. type: string readOnly: true x-omitempty: true DiskId: description: |- This field identifies the ID assigned to physical disks. type: string readOnly: true x-omitempty: true DiskState: description: |- This field identifies the health of the disk. type: string readOnly: true x-omitempty: true DriveFirmware: description: |- This field identifies the disk firmware running in the disk. type: string x-omitempty: true DriveState: description: |- The drive state as reported by the controller. type: string readOnly: true x-omitempty: true FdeCapable: description: |- Full-Disk Encryption capability parameter of the physical disk. type: string x-omitempty: true HotSpareType: description: |- Type of hotspare configured on the physical disk. type: string x-omitempty: true LinkSpeed: description: |- The speed of the link between the drive and the controller. type: string readOnly: true x-omitempty: true LinkState: description: |- The current link state of the physical disk. type: string readOnly: true x-omitempty: true NumBlocks: description: |- The number of blocks present on the physical disk. type: string readOnly: true x-omitempty: true OperPowerState: description: |- Operational power of the physical disk. type: string readOnly: true x-omitempty: true OperQualifierReason: description: |- This reason for the operational status of the disk. type: string readOnly: true x-omitempty: true Operability: description: |- This field identifies the disk operability of the disk. type: string readOnly: true x-omitempty: true PhysicalBlockSize: description: |- The block size of the installed physical disk. type: string readOnly: true x-omitempty: true Pid: description: |- This field identifies the Product ID for physicalDisk. type: string readOnly: true x-omitempty: true Presence: description: |- The presence state of the physical disk. type: string readOnly: true x-omitempty: true Protocol: description: |- This field identifies the disk protocol used for communication. type: string readOnly: true x-omitempty: true RawSize: description: |- The raw size of the physical disk in MB. type: string readOnly: true x-omitempty: true Secured: description: |- This field identifies whether the disk is encrypted. type: string x-omitempty: true Size: description: |- The size of the physical disk in MB. type: string readOnly: true x-omitempty: true Thermal: description: |- Thermal state of the physical disk. type: string readOnly: true x-omitempty: true Type: description: |- This field identifies the type of the physical disk. type: string readOnly: true x-omitempty: true VariantType: description: |- The variant type of the physical disk. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true LocatorLed: # A Relationship to MO equipment.LocatorLed $ref: '#/components/schemas/equipment.LocatorLed.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentLocatorLed resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalDiskExtensions: # A Relationship to MO storage.PhysicalDiskExtension description: An array of relationships to storagePhysicalDiskExtension resources. type: array items: $ref: '#/components/schemas/storage.PhysicalDiskExtension.Relationship' nullable: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RunningFirmware: # A Relationship to MO firmware.RunningFirmware description: An array of relationships to firmwareRunningFirmware resources. type: array items: $ref: '#/components/schemas/firmware.RunningFirmware.Relationship' nullable: true readOnly: true SasPorts: # A Relationship to MO storage.SasPort description: An array of relationships to storageSasPort resources. type: array items: $ref: '#/components/schemas/storage.SasPort.Relationship' nullable: true readOnly: true StorageController: # A Relationship to MO storage.Controller $ref: '#/components/schemas/storage.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageEnclosure: # A Relationship to MO storage.Enclosure $ref: '#/components/schemas/storage.Enclosure.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageEnclosure resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PhysicalDisk.List: title: List of 'storage.PhysicalDisk' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PhysicalDisk' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PhysicalDisk' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PhysicalDisk' nullable: true storage.PhysicalDiskExtension.Response: description: |- The response body of a HTTP GET request for the 'storage.PhysicalDiskExtension' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PhysicalDiskExtension' resources. x-one-of-name: storage.PhysicalDiskExtension.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PhysicalDiskExtension.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PhysicalDiskExtension.Relationship: description: A relationship to the 'storage.PhysicalDiskExtension' resource, or the expanded 'storage.PhysicalDiskExtension' resource, or the 'null' value. x-one-of-name: storage.PhysicalDiskExtension.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PhysicalDiskExtension' storage.PhysicalDiskExtension: title: Storage:Physical Disk Extension description: |- Information of disks as reported by controller. In certain cases like S-series servers, disk information will be reported by controller separately and this represents such information. x-allOf-name: storage.PhysicalDiskExtension allOf: - # This 'storage.PhysicalDiskExtension' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.PhysicalDiskExtension' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PhysicalDiskExtension', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PhysicalDiskExtension' ObjectType: enum: - 'storage.PhysicalDiskExtension' Bootable: description: |- The whether disk is bootable or not. type: string readOnly: true x-omitempty: true DiskDn: description: |- The distinguished name of the Physical drive. type: string readOnly: true x-omitempty: true DiskId: description: |- The storage Enclosure slotId. type: integer format: int64 readOnly: true x-omitempty: true DiskState: description: |- The current drive state of disk. type: string readOnly: true x-omitempty: true Health: description: |- The current drive state of disk. type: string x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalDisk: # A Relationship to MO storage.PhysicalDisk $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePhysicalDisk resource. When the $expand query parameter is specified, the referenced resource is returned inline. RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageController: # A Relationship to MO storage.Controller $ref: '#/components/schemas/storage.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PhysicalDiskExtension.List: title: List of 'storage.PhysicalDiskExtension' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PhysicalDiskExtension' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PhysicalDiskExtension' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PhysicalDiskExtension' nullable: true storage.PhysicalDiskUsage.Response: description: |- The response body of a HTTP GET request for the 'storage.PhysicalDiskUsage' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PhysicalDiskUsage' resources. x-one-of-name: storage.PhysicalDiskUsage.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PhysicalDiskUsage.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PhysicalDiskUsage.Relationship: description: A relationship to the 'storage.PhysicalDiskUsage' resource, or the expanded 'storage.PhysicalDiskUsage' resource, or the 'null' value. x-one-of-name: storage.PhysicalDiskUsage.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PhysicalDiskUsage' storage.PhysicalDiskUsage: title: Storage:Physical Disk Usage description: |- Has usage map between physical disks and virtual drives. x-allOf-name: storage.PhysicalDiskUsage allOf: - # This 'storage.PhysicalDiskUsage' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.PhysicalDiskUsage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PhysicalDiskUsage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PhysicalDiskUsage' ObjectType: enum: - 'storage.PhysicalDiskUsage' NumberOfBlocks: description: |- The number of blocks that are a part of the virtual drive. type: string readOnly: true x-omitempty: true PhysicalDrive: description: |- The physical disk for which the usage is reported. type: string readOnly: true x-omitempty: true Span: description: |- The span of the physical disk. type: string readOnly: true x-omitempty: true StartingBlock: description: |- The starting block id of the virtual drive within the physical drive. type: string readOnly: true x-omitempty: true State: description: |- The current state of the physical disk usage. type: string readOnly: true x-omitempty: true VirtualDrive: description: |- The virtual drive corresponding to the physical disk. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PhysicalDiskUsage.List: title: List of 'storage.PhysicalDiskUsage' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PhysicalDiskUsage' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PhysicalDiskUsage' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PhysicalDiskUsage' nullable: true storage.PureArray.Response: description: |- The response body of a HTTP GET request for the 'storage.PureArray' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureArray' resources. x-one-of-name: storage.PureArray.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureArray.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureArray.Relationship: description: A relationship to the 'storage.PureArray' resource, or the expanded 'storage.PureArray' resource, or the 'null' value. x-one-of-name: storage.PureArray.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PureArray' storage.PureArray: title: Storage:Pure Array description: |- The details of the Pure storage array. x-allOf-name: storage.PureArray allOf: - # This 'storage.PureArray' class inherits all properties from its parent class storage.BaseArray. $ref: '#/components/schemas/storage.BaseArray' - # The definition of all the properties specified in this 'storage.PureArray' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureArray', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureArray' ObjectType: enum: - 'storage.PureArray' RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureArray.List: title: List of 'storage.PureArray' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureArray' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureArray' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureArray' nullable: true storage.PureArrayUtilization: title: Storage:Pure Array Utilization description: |- Storage space consumption of Pure FlashArray. x-allOf-name: storage.PureArrayUtilization allOf: - # This 'storage.PureArrayUtilization' class inherits all properties from its parent class storage.BaseCapacity. $ref: '#/components/schemas/storage.BaseCapacity' - # The definition of all the properties specified in this 'storage.PureArrayUtilization' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureArrayUtilization', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureArrayUtilization' ObjectType: enum: - 'storage.PureArrayUtilization' DataReduction: description: |- Ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5.0 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules. type: number format: float readOnly: true x-omitempty: true Parity: description: |- Percentage of data that is fully protected. The percentage value will drop below 100% if the data is not fully protected. type: number format: float readOnly: true x-omitempty: true Provisioned: description: |- Total provisioned storage capacity in Pure FlashArray, represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true Shared: description: |- Physical space occupied by deduplicated data, represented in bytes. The space is shared with other volumes and snapshots as a result of data deduplication. type: integer format: int64 readOnly: true x-omitempty: true Snapshot: description: |- Physical space occupied by the snapshots, represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true System: description: |- Physical space occupied by internal array metadata, represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true ThinProvisioned: description: |- Percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed. type: number format: float readOnly: true x-omitempty: true TotalReduction: description: |- Ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10.0 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules. type: number format: float readOnly: true x-omitempty: true Volume: description: |- Physical space occupied by volume data, excluding shared, array metadata and snapshots. Size is represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true storage.PureController.Response: description: |- The response body of a HTTP GET request for the 'storage.PureController' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureController' resources. x-one-of-name: storage.PureController.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureController.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureController.Relationship: description: A relationship to the 'storage.PureController' resource, or the expanded 'storage.PureController' resource, or the 'null' value. x-one-of-name: storage.PureController.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PureController' storage.PureController: title: Storage:Pure Controller description: |- A storage controller entity in Pure FlashArray. x-allOf-name: storage.PureController allOf: - # This 'storage.PureController' class inherits all properties from its parent class storage.BaseArrayController. $ref: '#/components/schemas/storage.BaseArrayController' - # The definition of all the properties specified in this 'storage.PureController' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureController', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureController' ObjectType: enum: - 'storage.PureController' Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureController.List: title: List of 'storage.PureController' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureController' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureController' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureController' nullable: true storage.PureDisk.Response: description: |- The response body of a HTTP GET request for the 'storage.PureDisk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureDisk' resources. x-one-of-name: storage.PureDisk.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureDisk.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureDisk: title: Storage:Pure Disk description: |- Disk entity associated with Pure FlashArray. x-allOf-name: storage.PureDisk allOf: - # This 'storage.PureDisk' class inherits all properties from its parent class storage.BaseArrayDisk. $ref: '#/components/schemas/storage.BaseArrayDisk' - # The definition of all the properties specified in this 'storage.PureDisk' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureDisk', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureDisk' ObjectType: enum: - 'storage.PureDisk' Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureDisk.List: title: List of 'storage.PureDisk' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureDisk' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureDisk' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureDisk' nullable: true storage.PureDiskUtilization: title: Storage:Pure Disk Utilization description: |- Storage space utilization of Pure FlashArray drive entity. x-allOf-name: storage.PureDiskUtilization allOf: - # This 'storage.PureDiskUtilization' class inherits all properties from its parent class storage.BaseCapacity. $ref: '#/components/schemas/storage.BaseCapacity' storage.PureHost.Response: description: |- The response body of a HTTP GET request for the 'storage.PureHost' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureHost' resources. x-one-of-name: storage.PureHost.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureHost.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureHost.Relationship: description: A relationship to the 'storage.PureHost' resource, or the expanded 'storage.PureHost' resource, or the 'null' value. x-one-of-name: storage.PureHost.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PureHost' storage.PureHost: title: Storage:Pure Host description: |- A host entity in PureStorage FlashArray. It is an abstraction used by PureStorage to organize the storage network addresses (Fibre Channel worldwide names or iSCSI qualified names) of client computers and to control communications between clients and volumes. x-allOf-name: storage.PureHost allOf: - # This 'storage.PureHost' class inherits all properties from its parent class storage.BaseHost. $ref: '#/components/schemas/storage.BaseHost' - # The definition of all the properties specified in this 'storage.PureHost' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureHost', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureHost' ObjectType: enum: - 'storage.PureHost' HostGroupName: description: |- Name of host group where the host belongs to. Empty if host is not part of any HostGroup. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true HostGroup: # A Relationship to MO storage.PureHostGroup $ref: '#/components/schemas/storage.PureHostGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureHostGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ProtectionGroup: # A Relationship to MO storage.PureProtectionGroup $ref: '#/components/schemas/storage.PureProtectionGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureProtectionGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureHost.List: title: List of 'storage.PureHost' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureHost' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureHost' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureHost' nullable: true storage.PureHostGroup.Response: description: |- The response body of a HTTP GET request for the 'storage.PureHostGroup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureHostGroup' resources. x-one-of-name: storage.PureHostGroup.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureHostGroup.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureHostGroup.Relationship: description: A relationship to the 'storage.PureHostGroup' resource, or the expanded 'storage.PureHostGroup' resource, or the 'null' value. x-one-of-name: storage.PureHostGroup.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PureHostGroup' storage.PureHostGroup: title: Storage:Pure Host Group description: |- A host group represents a collection of hosts with common connectivity to volumes. Once a connection has been established between a host group and a volume, all of the hosts within the host group are able to access the volume through the connection. These connections are called shared connections because the connection is shared between all of the hosts within the host group. x-allOf-name: storage.PureHostGroup allOf: - # This 'storage.PureHostGroup' class inherits all properties from its parent class storage.BaseHostGroup. $ref: '#/components/schemas/storage.BaseHostGroup' - # The definition of all the properties specified in this 'storage.PureHostGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureHostGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureHostGroup' ObjectType: enum: - 'storage.PureHostGroup' HostNames: type: array items: description: |- Names of the host which are associated with the host group. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Hosts: # A Relationship to MO storage.PureHost description: An array of relationships to storagePureHost resources. type: array items: $ref: '#/components/schemas/storage.PureHost.Relationship' nullable: true readOnly: true ProtectionGroup: # A Relationship to MO storage.PureProtectionGroup $ref: '#/components/schemas/storage.PureProtectionGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureProtectionGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureHostGroup.List: title: List of 'storage.PureHostGroup' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureHostGroup' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureHostGroup' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureHostGroup' nullable: true storage.PureHostLun.Response: description: |- The response body of a HTTP GET request for the 'storage.PureHostLun' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureHostLun' resources. x-one-of-name: storage.PureHostLun.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureHostLun.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureHostLun: title: Storage:Pure Host Lun description: |- A host LUN entity in Pure storage array. It exists only if the volume has a connection to host or host group. For host group mapping, it provides public connection to all hosts associated within host group. A volume can have private connection to host as well. It cannot have public and private connection. Pure assign same HLU for all the host in case if it is connected through host group. x-allOf-name: storage.PureHostLun allOf: - # This 'storage.PureHostLun' class inherits all properties from its parent class storage.BaseHostLun. $ref: '#/components/schemas/storage.BaseHostLun' - # The definition of all the properties specified in this 'storage.PureHostLun' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureHostLun', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureHostLun' ObjectType: enum: - 'storage.PureHostLun' HostGroupName: description: |- Name of the host group associated with LUN. type: string readOnly: true x-omitempty: true Shared: description: |- Kind of volume connection to host. True if it is connected through host group. False in case of direct host connection. type: boolean readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Host: # A Relationship to MO storage.PureHost $ref: '#/components/schemas/storage.PureHost.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureHost resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true HostGroup: # A Relationship to MO storage.PureHostGroup $ref: '#/components/schemas/storage.PureHostGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureHostGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Volume: # A Relationship to MO storage.PureVolume $ref: '#/components/schemas/storage.PureVolume.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureVolume resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureHostLun.List: title: List of 'storage.PureHostLun' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureHostLun' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureHostLun' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureHostLun' nullable: true storage.PureHostUtilization: title: Storage:Pure Host Utilization description: |- Storage space utilization of Pure FlashArray host entity. x-allOf-name: storage.PureHostUtilization allOf: - # This 'storage.PureHostUtilization' class inherits all properties from its parent class storage.StorageUtilization. $ref: '#/components/schemas/storage.StorageUtilization' storage.PurePort.Response: description: |- The response body of a HTTP GET request for the 'storage.PurePort' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PurePort' resources. x-one-of-name: storage.PurePort.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PurePort.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PurePort: title: Storage:Pure Port description: |- Port entity in Pure FlashArray. x-allOf-name: storage.PurePort allOf: - # This 'storage.PurePort' class inherits all properties from its parent class storage.BasePhysicalPort. $ref: '#/components/schemas/storage.BasePhysicalPort' - # The definition of all the properties specified in this 'storage.PurePort' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PurePort', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PurePort' ObjectType: enum: - 'storage.PurePort' Failover: description: |- Name of the port to which this port has failed over. type: string readOnly: true x-omitempty: true Portal: description: |- Ip address of iSCSI portal configured on the port. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Controller: # A Relationship to MO storage.PureController $ref: '#/components/schemas/storage.PureController.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PurePort.List: title: List of 'storage.PurePort' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PurePort' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PurePort' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PurePort' nullable: true storage.PureProtectionGroup.Response: description: |- The response body of a HTTP GET request for the 'storage.PureProtectionGroup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureProtectionGroup' resources. x-one-of-name: storage.PureProtectionGroup.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureProtectionGroup.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureProtectionGroup.Relationship: description: A relationship to the 'storage.PureProtectionGroup' resource, or the expanded 'storage.PureProtectionGroup' resource, or the 'null' value. x-one-of-name: storage.PureProtectionGroup.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PureProtectionGroup' storage.PureProtectionGroup: title: Storage:Pure Protection Group description: |- Protection group entity in Pure storage array. A volume can be protected by associating with protection group either directly or indirectly (either host or host group). Snapshots are created on protected volume in local array or target array or both as per scheduler configuration. x-allOf-name: storage.PureProtectionGroup allOf: - # This 'storage.PureProtectionGroup' class inherits all properties from its parent class storage.BaseProtectionGroup. $ref: '#/components/schemas/storage.BaseProtectionGroup' - # The definition of all the properties specified in this 'storage.PureProtectionGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureProtectionGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureProtectionGroup' ObjectType: enum: - 'storage.PureProtectionGroup' Size: description: |- Overall size of all snapshots in the protection group, represented in bytes. type: integer format: int64 x-omitempty: true Source: description: |- Name of PureStorage array name on which the protection group is created. type: string readOnly: true x-omitempty: true Targets: type: array items: description: |- Target PureStorage array names where the replication snapshots are created. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true HostGroups: # A Relationship to MO storage.PureHostGroup description: An array of relationships to storagePureHostGroup resources. type: array items: $ref: '#/components/schemas/storage.PureHostGroup.Relationship' nullable: true readOnly: true Hosts: # A Relationship to MO storage.PureHost description: An array of relationships to storagePureHost resources. type: array items: $ref: '#/components/schemas/storage.PureHost.Relationship' nullable: true readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Volumes: # A Relationship to MO storage.PureVolume description: An array of relationships to storagePureVolume resources. type: array items: $ref: '#/components/schemas/storage.PureVolume.Relationship' nullable: true readOnly: true storage.PureProtectionGroup.List: title: List of 'storage.PureProtectionGroup' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureProtectionGroup' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureProtectionGroup' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureProtectionGroup' nullable: true storage.PureProtectionGroupSnapshot.Response: description: |- The response body of a HTTP GET request for the 'storage.PureProtectionGroupSnapshot' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureProtectionGroupSnapshot' resources. x-one-of-name: storage.PureProtectionGroupSnapshot.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureProtectionGroupSnapshot.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureProtectionGroupSnapshot.Relationship: description: A relationship to the 'storage.PureProtectionGroupSnapshot' resource, or the expanded 'storage.PureProtectionGroupSnapshot' resource, or the 'null' value. x-one-of-name: storage.PureProtectionGroupSnapshot.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PureProtectionGroupSnapshot' storage.PureProtectionGroupSnapshot: title: Storage:Pure Protection Group Snapshot description: |- Protection group snapshot entity in Pure protection group. x-allOf-name: storage.PureProtectionGroupSnapshot allOf: - # This 'storage.PureProtectionGroupSnapshot' class inherits all properties from its parent class storage.BaseProtectionGroupSnapshot. $ref: '#/components/schemas/storage.BaseProtectionGroupSnapshot' - # The definition of all the properties specified in this 'storage.PureProtectionGroupSnapshot' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureProtectionGroupSnapshot', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureProtectionGroupSnapshot' ObjectType: enum: - 'storage.PureProtectionGroupSnapshot' Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ProtectionGroup: # A Relationship to MO storage.PureProtectionGroup $ref: '#/components/schemas/storage.PureProtectionGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureProtectionGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureProtectionGroupSnapshot.List: title: List of 'storage.PureProtectionGroupSnapshot' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureProtectionGroupSnapshot' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureProtectionGroupSnapshot' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureProtectionGroupSnapshot' nullable: true storage.PureReplicationBlackout: title: Storage:Pure Replication Blackout description: |- Range of time at which to suspend replication. System disables replication during this interval. x-allOf-name: storage.PureReplicationBlackout allOf: - # This 'storage.PureReplicationBlackout' class inherits all properties from its parent class storage.BaseReplicationBlackout. $ref: '#/components/schemas/storage.BaseReplicationBlackout' storage.PureReplicationSchedule.Response: description: |- The response body of a HTTP GET request for the 'storage.PureReplicationSchedule' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureReplicationSchedule' resources. x-one-of-name: storage.PureReplicationSchedule.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureReplicationSchedule.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureReplicationSchedule: title: Storage:Pure Replication Schedule description: |- Pure snapshot replication schedule entity. x-allOf-name: storage.PureReplicationSchedule allOf: - # This 'storage.PureReplicationSchedule' class inherits all properties from its parent class storage.BaseReplicationSchedule. $ref: '#/components/schemas/storage.BaseReplicationSchedule' - # The definition of all the properties specified in this 'storage.PureReplicationSchedule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureReplicationSchedule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureReplicationSchedule' ObjectType: enum: - 'storage.PureReplicationSchedule' DailyLimit: description: |- Total number of snapshots per day to be available on target above and over the specified retention time. PureStorage FlashArray maintains all created snapshot until retention period. Daily limit is applied only on the snapshots once retention time is expired. In case of, daily limit is less than the number of snapshot available on source, system select snapshots evenly spaced out throughout the day. type: integer format: int64 readOnly: true x-omitempty: true ReplicationBlackoutIntervals: type: array items: description: |- Blackout intervals for replication operation in PureStorage FlashArray. System disables replication during these intervals. Blackout periods only apply to scheduled replications. On-demand replications do not observe the blackout period. $ref: '#/components/schemas/storage.PureReplicationBlackout' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true SnapshotExpiryTime: description: |- Duration to keep the daily limit snapshots on target array. StorageArray deletes the snapshots permanently from the targets beyond this period. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ProtectionGroup: # A Relationship to MO storage.PureProtectionGroup $ref: '#/components/schemas/storage.PureProtectionGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureProtectionGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureReplicationSchedule.List: title: List of 'storage.PureReplicationSchedule' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureReplicationSchedule' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureReplicationSchedule' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureReplicationSchedule' nullable: true storage.PureSnapshotSchedule.Response: description: |- The response body of a HTTP GET request for the 'storage.PureSnapshotSchedule' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureSnapshotSchedule' resources. x-one-of-name: storage.PureSnapshotSchedule.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureSnapshotSchedule.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureSnapshotSchedule: title: Storage:Pure Snapshot Schedule description: |- PureStorage FlashArray snapshot schedule configuration entity. x-allOf-name: storage.PureSnapshotSchedule allOf: - # This 'storage.PureSnapshotSchedule' class inherits all properties from its parent class storage.BaseSnapshotSchedule. $ref: '#/components/schemas/storage.BaseSnapshotSchedule' - # The definition of all the properties specified in this 'storage.PureSnapshotSchedule' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureSnapshotSchedule', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureSnapshotSchedule' ObjectType: enum: - 'storage.PureSnapshotSchedule' DailyLimit: description: |- Total number of snapshots per day to be available on source above and over the specified retention time. PureStorage FlashArray maintains all created snapshot until retention period. Daily limit is applied only on the snapshots once retention time is expired. In case of, daily limit is less than the number of snapshot available on source, system select snapshots evenly spaced out throughout the day. type: integer format: int64 readOnly: true x-omitempty: true SnapshotExpiryTime: description: |- Duration to keep the daily limit snapshots on source array. StorageArray deletes the snapshots permanently from source beyond this period. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ProtectionGroup: # A Relationship to MO storage.PureProtectionGroup $ref: '#/components/schemas/storage.PureProtectionGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureProtectionGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureSnapshotSchedule.List: title: List of 'storage.PureSnapshotSchedule' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureSnapshotSchedule' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureSnapshotSchedule' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureSnapshotSchedule' nullable: true storage.PureVolume.Response: description: |- The response body of a HTTP GET request for the 'storage.PureVolume' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureVolume' resources. x-one-of-name: storage.PureVolume.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureVolume.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureVolume.Relationship: description: A relationship to the 'storage.PureVolume' resource, or the expanded 'storage.PureVolume' resource, or the 'null' value. x-one-of-name: storage.PureVolume.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.PureVolume' storage.PureVolume: title: Storage:Pure Volume description: |- A volume entity in PureStorage FlashArray. x-allOf-name: storage.PureVolume allOf: - # This 'storage.PureVolume' class inherits all properties from its parent class storage.BaseVolume. $ref: '#/components/schemas/storage.BaseVolume' - # The definition of all the properties specified in this 'storage.PureVolume' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureVolume', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureVolume' ObjectType: enum: - 'storage.PureVolume' Created: description: |- Creation time of the volume. type: string format: date-time readOnly: true x-omitempty: true Serial: description: |- Serial number of the volume. type: string readOnly: true x-omitempty: true Source: description: |- Source from which the volume is created. Applicable only if the volume is cloned from other volume or snapshot. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ProtectionGroup: # A Relationship to MO storage.PureProtectionGroup $ref: '#/components/schemas/storage.PureProtectionGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureProtectionGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureVolume.List: title: List of 'storage.PureVolume' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureVolume' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureVolume' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureVolume' nullable: true storage.PureVolumeSnapshot.Response: description: |- The response body of a HTTP GET request for the 'storage.PureVolumeSnapshot' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.PureVolumeSnapshot' resources. x-one-of-name: storage.PureVolumeSnapshot.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.PureVolumeSnapshot.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.PureVolumeSnapshot: title: Storage:Pure Volume Snapshot description: |- Volume snapshot entity in Pure protection group. Volume snapshots are created either on-demand or using scheduler. Snapshots are immutable and it cannot be connected to hosts or host groups, and therefore the data it contains cannot be read or written. x-allOf-name: storage.PureVolumeSnapshot allOf: - # This 'storage.PureVolumeSnapshot' class inherits all properties from its parent class storage.BaseSnapshot. $ref: '#/components/schemas/storage.BaseSnapshot' - # The definition of all the properties specified in this 'storage.PureVolumeSnapshot' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.PureVolumeSnapshot', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.PureVolumeSnapshot' ObjectType: enum: - 'storage.PureVolumeSnapshot' Serial: description: |- Unique serial number of the snapshot allocated by the storage array. type: string readOnly: true x-omitempty: true Array: # A Relationship to MO storage.PureArray $ref: '#/components/schemas/storage.PureArray.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureArray resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ProtectionGroupSnapshot: # A Relationship to MO storage.PureProtectionGroupSnapshot $ref: '#/components/schemas/storage.PureProtectionGroupSnapshot.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureProtectionGroupSnapshot resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Volume: # A Relationship to MO storage.PureVolume $ref: '#/components/schemas/storage.PureVolume.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePureVolume resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.PureVolumeSnapshot.List: title: List of 'storage.PureVolumeSnapshot' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.PureVolumeSnapshot' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.PureVolumeSnapshot' resources matching the request. type: array items: $ref: '#/components/schemas/storage.PureVolumeSnapshot' nullable: true storage.PureVolumeUtilization: title: Storage:Pure Volume Utilization description: |- Storage space utilization of Pure FlashArray volume entity. x-allOf-name: storage.PureVolumeUtilization allOf: - # This 'storage.PureVolumeUtilization' class inherits all properties from its parent class storage.StorageUtilization. $ref: '#/components/schemas/storage.StorageUtilization' storage.RemoteKeySetting: title: Remote Key Management description: |- Models the remote key configurarion required for disks encryptions. KMIP is the only remote key protocol supported in the policy. x-allOf-name: storage.RemoteKeySetting allOf: - # This 'storage.RemoteKeySetting' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'storage.RemoteKeySetting' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.RemoteKeySetting', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.RemoteKeySetting' ObjectType: enum: - 'storage.RemoteKeySetting' IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Password: description: |- The password for the KMIP server login. type: string pattern: "[!\"#%&'\\(\\)\\*\\+,\\-\\./:;<>@\\[\\\\\\]\\^_`\\{\\|\\}~a-zA-Z0-9]{0,80}" writeOnly: true x-omitempty: true Port: description: |- The port to which the KMIP client should connect. type: integer format: int64 minimum: 1024 maximum: 65535 x-omitempty: true PrimaryServer: description: |- The IP address of the primary KMIP server. It could be an IPv4 address, an IPv6 address, or a hostname. Hostnames are valid only when Inband is configured for the CIMC address. type: string x-omitempty: true SecondaryServer: description: |- The IP address of the secondary KMIP server. It could be an IPv4 address, an IPv6 address, or a hostname. Hostnames are valid only when Inband is configured for the CIMC address. type: string x-omitempty: true ServerCertificate: description: |- The certificate/ public key of the KMIP server. It is required for initiating secure communication with the server. type: string x-omitempty: true Username: description: |- The user name for the KMIP server login. type: string pattern: "^$|[a-zA-Z][a-zA-Z0-9_.-]{0,31}" x-omitempty: true storage.SasExpander.Response: description: |- The response body of a HTTP GET request for the 'storage.SasExpander' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.SasExpander' resources. x-one-of-name: storage.SasExpander.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.SasExpander.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.SasExpander.Relationship: description: A relationship to the 'storage.SasExpander' resource, or the expanded 'storage.SasExpander' resource, or the 'null' value. x-one-of-name: storage.SasExpander.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.SasExpander' storage.SasExpander: title: Storage:Sas Expander description: |- SAS Expander present in a server. x-allOf-name: storage.SasExpander allOf: - # This 'storage.SasExpander' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.SasExpander' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.SasExpander', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.SasExpander' ObjectType: enum: - 'storage.SasExpander' ExpanderId: description: |- Unique Identifier of the storage expander. type: integer format: int64 readOnly: true x-omitempty: true Name: description: |- The name of the installed storage expander. type: string x-omitempty: true OperState: description: |- The operational state of the storage expander. type: string readOnly: true x-omitempty: true Operability: description: |- The operability status of the storage expander. type: string readOnly: true x-omitempty: true Presence: description: |- The availability of the storage expander. type: string readOnly: true x-omitempty: true SasAddress: description: |- The SAS address of the SAS expander. type: string readOnly: true x-omitempty: true ComputeRackUnit: # A Relationship to MO compute.RackUnit $ref: '#/components/schemas/compute.RackUnit.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a computeRackUnit resource. When the $expand query parameter is specified, the referenced resource is returned inline. Controller: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true EquipmentChassis: # A Relationship to MO equipment.Chassis $ref: '#/components/schemas/equipment.Chassis.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a equipmentChassis resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.SasExpander.List: title: List of 'storage.SasExpander' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.SasExpander' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.SasExpander' resources matching the request. type: array items: $ref: '#/components/schemas/storage.SasExpander' nullable: true storage.SasPort.Response: description: |- The response body of a HTTP GET request for the 'storage.SasPort' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.SasPort' resources. x-one-of-name: storage.SasPort.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.SasPort.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.SasPort.Relationship: description: A relationship to the 'storage.SasPort' resource, or the expanded 'storage.SasPort' resource, or the 'null' value. x-one-of-name: storage.SasPort.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.SasPort' storage.SasPort: title: Storage:Sas Port description: |- Sas Port details of the SAS endpoint. x-allOf-name: storage.SasPort allOf: - # This 'storage.SasPort' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.SasPort' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.SasPort', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.SasPort' ObjectType: enum: - 'storage.SasPort' Address: description: |- The SAS Address assigned to storage port. type: string readOnly: true x-omitempty: true DiskId: description: |- The unique disk identifier. type: integer format: int64 readOnly: true x-omitempty: true EndPointId: description: |- The end-point Id assigned to storage port. type: integer format: int64 readOnly: true x-omitempty: true LinkDescription: description: |- The description for the link. type: string readOnly: true x-omitempty: true LinkSpeed: description: |- The link speed negotiated for communication. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StoragePhysicalDisk: # A Relationship to MO storage.PhysicalDisk $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storagePhysicalDisk resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.SasPort.List: title: List of 'storage.SasPort' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.SasPort' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.SasPort' resources matching the request. type: array items: $ref: '#/components/schemas/storage.SasPort' nullable: true storage.Span.Response: description: |- The response body of a HTTP GET request for the 'storage.Span' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.Span' resources. x-one-of-name: storage.Span.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.Span.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.Span.Relationship: description: A relationship to the 'storage.Span' resource, or the expanded 'storage.Span' resource, or the 'null' value. x-one-of-name: storage.Span.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.Span' storage.Span: title: Storage:Span description: |- Group of disks to configure virtual drive. x-allOf-name: storage.Span allOf: - # This 'storage.Span' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.Span' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.Span', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.Span' ObjectType: enum: - 'storage.Span' Slots: type: array items: description: |- Drive Slots belonging to this span. type: integer format: int64 x-omitempty: true SpanId: description: |- Unique identifier value of this span. type: integer format: int64 x-omitempty: true DiskGroup: # A Relationship to MO storage.DiskGroup $ref: '#/components/schemas/storage.DiskGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageDiskGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. PhysicalDisks: # A Relationship to MO storage.PhysicalDisk description: An array of relationships to storagePhysicalDisk resources. type: array items: $ref: '#/components/schemas/storage.PhysicalDisk.Relationship' nullable: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.Span.List: title: List of 'storage.Span' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.Span' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.Span' resources matching the request. type: array items: $ref: '#/components/schemas/storage.Span' nullable: true storage.SpanGroup: title: Storage:Span Group description: |- This models a single span group of disks in a RAID group. x-allOf-name: storage.SpanGroup allOf: - # This 'storage.SpanGroup' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'storage.SpanGroup' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.SpanGroup', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.SpanGroup' ObjectType: enum: - 'storage.SpanGroup' Disks: type: array items: description: |- Collection of local disks that are part of this span group. The minimum number of disks needed in a span group varies based on RAID level. Raid0 requires at least one disk, Raid1 and Raid10 requires at least 2 and in multiples of 2, Raid5 Raid50 Raid6 and Raid60 require at least 3 disks in a span group. $ref: '#/components/schemas/storage.LocalDisk' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true storage.StoragePolicy.Response: description: |- The response body of a HTTP GET request for the 'storage.StoragePolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.StoragePolicy' resources. x-one-of-name: storage.StoragePolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.StoragePolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.StoragePolicy.Relationship: description: A relationship to the 'storage.StoragePolicy' resource, or the expanded 'storage.StoragePolicy' resource, or the 'null' value. x-one-of-name: storage.StoragePolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.StoragePolicy' storage.StoragePolicy: title: Storage description: |- The storage policy models the reusable storage related configuration that can be applied on many servers. This policy allows creation of RAID groups using existing disk group policies and virtual drives on the drive groups. The user has options to move all unused disks to JBOD or Unconfigured good state. The encryption of drives can be enabled through this policy using remote keys from a KMIP server. x-allOf-name: storage.StoragePolicy allOf: - # This 'storage.StoragePolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'storage.StoragePolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.StoragePolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.StoragePolicy' ObjectType: enum: - 'storage.StoragePolicy' GlobalHotSpares: type: array items: description: |- A collection of disks used as hot spares globally for all the RAID groups. $ref: '#/components/schemas/storage.LocalDisk' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true RetainPolicyVirtualDrives: description: |- Retains the virtual drives defined in policy if they exist already. If this flag is false, the existing virtual drives are removed and created again based on virtual drives in the policy. type: boolean x-omitempty: true UnusedDisksState: description: |- Unused Disks State is used to specify the state, unconfigured good or jbod, in which the disks that are not used in this policy should be moved. * `UnconfiguredGood` - Unconfigured good state -ready to be added in a RAID group. * `Jbod` - JBOD state where the disks start showing up to host os. type: string enum: - 'UnconfiguredGood' - 'Jbod' default: UnconfiguredGood x-omitempty: true VirtualDrives: type: array items: description: |- The list of virtual drives and the disk groups that need to be created through this policy. $ref: '#/components/schemas/storage.VirtualDriveConfig' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true DiskGroupPolicies: # A Relationship to MO storage.DiskGroupPolicy description: An array of relationships to storageDiskGroupPolicy resources. type: array items: $ref: '#/components/schemas/storage.DiskGroupPolicy.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true storage.StoragePolicy.List: title: List of 'storage.StoragePolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.StoragePolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.StoragePolicy' resources matching the request. type: array items: $ref: '#/components/schemas/storage.StoragePolicy' nullable: true storage.StorageUtilization: title: Storage:Storage Utilization description: |- Storage space utilized by Pure storage entity. x-allOf-name: storage.StorageUtilization allOf: - # This 'storage.StorageUtilization' class inherits all properties from its parent class storage.BaseCapacity. $ref: '#/components/schemas/storage.BaseCapacity' - # The definition of all the properties specified in this 'storage.StorageUtilization' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.StorageUtilization', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: DataReduction: description: |- Ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5.0 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules. type: number format: float readOnly: true x-omitempty: true Snapshot: description: |- Physical space occupied by the snapshots, represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true ThinProvisioned: description: |- Percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed. type: number format: float readOnly: true x-omitempty: true TotalReduction: description: |- Ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10.0 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules. type: number format: float readOnly: true x-omitempty: true Volume: description: |- Physical space occupied by volume data, excluding shared, array metadata and snapshots. Size id represented in bytes. type: integer format: int64 readOnly: true x-omitempty: true storage.VdMemberEp.Response: description: |- The response body of a HTTP GET request for the 'storage.VdMemberEp' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.VdMemberEp' resources. x-one-of-name: storage.VdMemberEp.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.VdMemberEp.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.VdMemberEp.Relationship: description: A relationship to the 'storage.VdMemberEp' resource, or the expanded 'storage.VdMemberEp' resource, or the 'null' value. x-one-of-name: storage.VdMemberEp.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.VdMemberEp' storage.VdMemberEp: title: Storage:Vd Member Ep description: |- Reference to LocalDisk to build up a VirtualDrive. x-allOf-name: storage.VdMemberEp allOf: - # This 'storage.VdMemberEp' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.VdMemberEp' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.VdMemberEp', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.VdMemberEp' ObjectType: enum: - 'storage.VdMemberEp' OperQualifierReason: description: |- For certain states, indicates the reason why the operState is in that state. type: string readOnly: true x-omitempty: true Presence: description: |- The presence state of the local disk. type: string readOnly: true x-omitempty: true Role: description: |- Role of the disk normal or hot-spare, used by virtual-drive. type: string readOnly: true x-omitempty: true SpanId: description: |- The span id number of the virtual drive. type: string readOnly: true x-omitempty: true VdMemberEpId: description: |- The local disk slot number as id. type: integer format: int64 readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageVirtualDrive: # A Relationship to MO storage.VirtualDrive $ref: '#/components/schemas/storage.VirtualDrive.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageVirtualDrive resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.VdMemberEp.List: title: List of 'storage.VdMemberEp' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.VdMemberEp' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.VdMemberEp' resources matching the request. type: array items: $ref: '#/components/schemas/storage.VdMemberEp' nullable: true storage.VirtualDrive.Response: description: |- The response body of a HTTP GET request for the 'storage.VirtualDrive' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.VirtualDrive' resources. x-one-of-name: storage.VirtualDrive.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.VirtualDrive.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.VirtualDrive.Relationship: description: A relationship to the 'storage.VirtualDrive' resource, or the expanded 'storage.VirtualDrive' resource, or the 'null' value. x-one-of-name: storage.VirtualDrive.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.VirtualDrive' storage.VirtualDrive: title: Storage:Virtual Drive description: |- A Virtual Disk Drive or Logical Unit Number. x-allOf-name: storage.VirtualDrive allOf: - # This 'storage.VirtualDrive' class inherits all properties from its parent class equipment.Base. $ref: '#/components/schemas/equipment.Base' - # The definition of all the properties specified in this 'storage.VirtualDrive' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.VirtualDrive', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.VirtualDrive' ObjectType: enum: - 'storage.VirtualDrive' AccessPolicy: description: |- The access policy of the virtual drive. type: string readOnly: true x-omitempty: true ActualWriteCachePolicy: description: |- The current write cache policy of the virtual drive. type: string readOnly: true x-omitempty: true AvailableSize: description: |- Available storage capacity of the virtual drive. type: string readOnly: true x-omitempty: true BlockSize: description: |- Block size of the virtual drive. type: string readOnly: true x-omitempty: true Bootable: description: |- The virtual drive bootable state. type: string readOnly: true x-omitempty: true ConfigState: description: |- The configuration state of the virtual drive. type: string readOnly: true x-omitempty: true ConfiguredWriteCachePolicy: description: |- The requested write cache policy of the virtual drive. type: string readOnly: true x-omitempty: true ConnectionProtocol: description: |- The connection protocol of the virtual drive. type: string readOnly: true x-omitempty: true DriveCache: description: |- The state of the drive cache of the virtual drive. type: string readOnly: true x-omitempty: true DriveSecurity: description: |- The driveSecurity state of the Virtual drive. type: string readOnly: true x-omitempty: true DriveState: description: |- The state of the Virtual drive. type: string readOnly: true x-omitempty: true IoPolicy: description: |- The Input/Output Policy defined on the Virtual drive. type: string readOnly: true x-omitempty: true Name: description: |- The name of the Virtual drive. type: string readOnly: true x-omitempty: true NumBlocks: description: |- Number of Blocks on the Physical Disk. type: string readOnly: true x-omitempty: true OperState: description: |- The current operational state of Virtual drive. type: string readOnly: true x-omitempty: true Operability: description: |- The current operability state of Virtual drive. type: string readOnly: true x-omitempty: true PhysicalBlockSize: description: |- The block size of the the virtual drive. type: string readOnly: true x-omitempty: true Presence: description: |- The presence status of the virtual drive. type: string readOnly: true x-omitempty: true ReadPolicy: description: |- The read-ahead cache mode of the virtual drive. type: string readOnly: true x-omitempty: true SecurityFlags: description: |- The security flags set for this virtual drive. type: string readOnly: true x-omitempty: true Size: description: |- The size of the virtual drive in MB. type: string readOnly: true x-omitempty: true StripSize: description: |- The strip size is the portion of a stripe that resides on a single drive in the drive group, this is measured in KB. type: string readOnly: true x-omitempty: true Type: description: |- The raid type of the virtual drive. type: string readOnly: true x-omitempty: true Uuid: description: |- The uuid of the virtual drive. type: string readOnly: true x-omitempty: true VendorUuid: description: |- The UUID value of the vendor. type: string readOnly: true x-omitempty: true VirtualDriveId: description: |- The identifier for this Virtual drive. type: string readOnly: true x-omitempty: true DiskGroup: # A Relationship to MO storage.DiskGroup $ref: '#/components/schemas/storage.DiskGroup.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageDiskGroup resource. When the $expand query parameter is specified, the referenced resource is returned inline. InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PhysicalDiskUsages: # A Relationship to MO storage.PhysicalDiskUsage description: An array of relationships to storagePhysicalDiskUsage resources. type: array items: $ref: '#/components/schemas/storage.PhysicalDiskUsage.Relationship' nullable: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageController: # A Relationship to MO storage.Controller $ref: '#/components/schemas/storage.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true VdMemberEps: # A Relationship to MO storage.VdMemberEp description: An array of relationships to storageVdMemberEp resources. type: array items: $ref: '#/components/schemas/storage.VdMemberEp.Relationship' nullable: true readOnly: true VirtualDriveExtension: # A Relationship to MO storage.VirtualDriveExtension $ref: '#/components/schemas/storage.VirtualDriveExtension.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageVirtualDriveExtension resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.VirtualDrive.List: title: List of 'storage.VirtualDrive' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.VirtualDrive' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.VirtualDrive' resources matching the request. type: array items: $ref: '#/components/schemas/storage.VirtualDrive' nullable: true storage.VirtualDriveConfig: title: Virtual Drive description: |- Virtual Drive type models a single virtual drive that needs to be created through this policy. x-allOf-name: storage.VirtualDriveConfig allOf: - # This 'storage.VirtualDriveConfig' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'storage.VirtualDriveConfig' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.VirtualDriveConfig', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.VirtualDriveConfig' ObjectType: enum: - 'storage.VirtualDriveConfig' AccessPolicy: description: |- Access policy that host has on this virtual drive. * `Default` - Use platform default access mode. * `ReadWrite` - Enables host to perform read-write on the VD. * `ReadOnly` - Host can only read from the VD. * `Blocked` - Host can neither read nor write to the VD. type: string enum: - 'Default' - 'ReadWrite' - 'ReadOnly' - 'Blocked' default: Default x-omitempty: true BootDrive: description: |- The flag enables the use of this virtual drive as a boot drive. type: boolean x-omitempty: true DiskGroupName: description: |- Disk group policy that has the disk group in which this virtual drive needs to be created. type: string readOnly: true x-omitempty: true DiskGroupPolicy: description: |- Disk group policy that has the disk group in which this virtual drive needs to be created. type: string x-omitempty: true DriveCache: description: |- Drive Cache property expect disk cache policy. * `Default` - Use platform default drive cache mode. * `NoChange` - Drive cache policy is unchanged. * `Enable` - Enables IO caching on the drive. * `Disable` - Disables IO caching on the drive. type: string enum: - 'Default' - 'NoChange' - 'Enable' - 'Disable' default: Default x-omitempty: true ExpandToAvailable: description: |- The flag enables this virtual drive to use all the available space in the disk group. When this flag is configured, the size property is ignored. type: boolean x-omitempty: true IoPolicy: description: |- Desired IO mode - direct IO or cached IO. * `Default` - Use platform default IO mode. * `Direct` - Use direct IO for writing directly into the disk. * `Cached` - Use cached IO for writing into cache and then to disk. type: string enum: - 'Default' - 'Direct' - 'Cached' default: Default x-omitempty: true Name: description: |- The name of the virtual drive. The name can be between 1 and 15 alphanumeric characters. Spaces or any special characters other than - (hyphen), _ (underscore), : (colon), and . (period) are not allowed. type: string pattern: "[-.:_a-zA-Z0-9]{1,15}" x-createOnly: true x-omitempty: true ReadPolicy: description: |- Read ahead mode to be used to read data from this virtual drive. * `Default` - Use platform default read ahead mode. * `ReadAhead` - Use read ahead mode for the policy. * `NoReadAhead` - Do not use read ahead mode for the policy. type: string enum: - 'Default' - 'ReadAhead' - 'NoReadAhead' default: Default x-omitempty: true Size: description: |- Virtual drive size in MB. Size is mandatory field unless the 'Expand to Available' option is enabled. type: integer format: int64 minimum: 0 x-omitempty: true StripSize: description: |- The strip size is the portion of a stripe that resides on a single drive in the drive group. The stripe consists of the data segments that the RAID controller writes across multiple drives, not including parity drives. * `Default` - Use platform default strip size for a virtual drive. * `32k` - Enables a strip size of 32k for a virtual drive. * `64k` - Enables a strip size of 64k for a virtual drive. * `128k` - Enables a strip size of 128k for a virtual drive. * `256k` - Enables a strip size of 256k for a virtual drive. * `512k` - Enables a strip size of 512k for a virtual drive. * `1024k` - Enables a strip size of 1024k for a virtual drive. type: string enum: - 'Default' - '32k' - '64k' - '128k' - '256k' - '512k' - '1024k' default: Default x-omitempty: true WritePolicy: description: |- Write mode to be used to write data to this virtual drive. * `Default` - Use platform default write mode. * `WriteThrough` - Data is written through the cache and to the physical drives. Performance is improved, because subsequent reads of that data can be satisfied from the cache. * `WriteBackGoodBbu` - Data is stored in the cache, and is only written to the physical drives when space in the cache is needed. Virtual drives requesting this policy fall back to Write Through caching when the battery backup unit (BBU) cannot guarantee the safety of the cache in the event of a power failure. * `AlwaysWriteBack` - With this policy, write caching remains Write Back even if the battery backup unit is defective or discharged. type: string enum: - 'Default' - 'WriteThrough' - 'WriteBackGoodBbu' - 'AlwaysWriteBack' default: Default x-omitempty: true storage.VirtualDriveExtension.Response: description: |- The response body of a HTTP GET request for the 'storage.VirtualDriveExtension' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'storage.VirtualDriveExtension' resources. x-one-of-name: storage.VirtualDriveExtension.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/storage.VirtualDriveExtension.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType storage.VirtualDriveExtension.Relationship: description: A relationship to the 'storage.VirtualDriveExtension' resource, or the expanded 'storage.VirtualDriveExtension' resource, or the 'null' value. x-one-of-name: storage.VirtualDriveExtension.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/storage.VirtualDriveExtension' storage.VirtualDriveExtension: title: Storage:Virtual Drive Extension description: |- Information of virtual drives as reported by a storage controller. In certain cases like S-series servers, virtual drive information will be reported by the controller separately and this represents such information. x-allOf-name: storage.VirtualDriveExtension allOf: - # This 'storage.VirtualDriveExtension' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'storage.VirtualDriveExtension' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'storage.VirtualDriveExtension', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'storage.VirtualDriveExtension' ObjectType: enum: - 'storage.VirtualDriveExtension' Bootable: description: |- The ability to boot from the virtual drive. type: string readOnly: true x-omitempty: true ContainerId: description: |- The container id of the virtual drive. type: integer format: int64 readOnly: true x-omitempty: true DriveState: description: |- The state of the virtual drive. type: string readOnly: true x-omitempty: true Name: description: |- The name of the Virtual drive. type: string readOnly: true x-omitempty: true OperDeviceId: description: |- The operational device id of the virtual drive. type: string readOnly: true x-omitempty: true Uuid: description: |- The UUID assigned to the virtual drive. type: string readOnly: true x-omitempty: true VendorUuid: description: |- The UUID value of the vendor assigned to the virtual drive. type: string readOnly: true x-omitempty: true VirtualDriveDn: description: |- The distinguished name of the virtual drive for which the extended data is provided. type: string readOnly: true x-omitempty: true VirtualDriveId: description: |- The Id of the virtual drive. type: string readOnly: true x-omitempty: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true StorageController: # A Relationship to MO storage.Controller $ref: '#/components/schemas/storage.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true VirtualDrive: # A Relationship to MO storage.VirtualDrive $ref: '#/components/schemas/storage.VirtualDrive.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a storageVirtualDrive resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true storage.VirtualDriveExtension.List: title: List of 'storage.VirtualDriveExtension' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'storage.VirtualDriveExtension' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'storage.VirtualDriveExtension' resources matching the request. type: array items: $ref: '#/components/schemas/storage.VirtualDriveExtension' nullable: true syslog.LocalClientBase: title: Syslog:Local Client Base description: |- Lists properties that are common to all local logging clients. It serves as base class for all local logging clients. x-allOf-name: syslog.LocalClientBase allOf: - # This 'syslog.LocalClientBase' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'syslog.LocalClientBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'syslog.LocalClientBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: MinSeverity: description: |- Lowest level of messages to be included in the local log. * `warning` - Use logging level warning for logs classified as warning. * `emergency` - Use logging level emergency for logs classified as emergency. * `alert` - Use logging level alert for logs classified as alert. * `critical` - Use logging level critical for logs classified as critical. * `error` - Use logging level error for logs classified as error. * `notice` - Use logging level notice for logs classified as notice. * `informational` - Use logging level informational for logs classified as informational. * `debug` - Use logging level debug for logs classified as debug. type: string enum: - 'warning' - 'emergency' - 'alert' - 'critical' - 'error' - 'notice' - 'informational' - 'debug' default: warning x-omitempty: true syslog.LocalFileLoggingClient: title: Local Client description: |- Local logging client on the endpoint. x-allOf-name: syslog.LocalFileLoggingClient allOf: - # This 'syslog.LocalFileLoggingClient' class inherits all properties from its parent class syslog.LocalClientBase. $ref: '#/components/schemas/syslog.LocalClientBase' syslog.Policy.Response: description: |- The response body of a HTTP GET request for the 'syslog.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'syslog.Policy' resources. x-one-of-name: syslog.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/syslog.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType syslog.Policy: title: Syslog description: |- The syslog policy configure the syslog server to receive CIMC log entries. x-allOf-name: syslog.Policy allOf: - # This 'syslog.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'syslog.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'syslog.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'syslog.Policy' ObjectType: enum: - 'syslog.Policy' LocalClients: type: array items: description: |- Set of local logging clients on the endpoint. $ref: '#/components/schemas/syslog.LocalClientBase' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 RemoteClients: type: array items: description: |- Set of remote logging clients on the endpoint. $ref: '#/components/schemas/syslog.RemoteClientBase' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true syslog.Policy.List: title: List of 'syslog.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'syslog.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'syslog.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/syslog.Policy' nullable: true syslog.RemoteClientBase: title: Syslog:Remote Client Base description: |- Lists properties that are common to all remote logging clients. It serves as a base class for all remote logging clients. x-allOf-name: syslog.RemoteClientBase allOf: - # This 'syslog.RemoteClientBase' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'syslog.RemoteClientBase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'syslog.RemoteClientBase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Enabled: description: |- Enables/disables remote logging for the endpoint If enabled, log messages will be sent to the syslog server mentioned in the Hostname/IP Address field. type: boolean x-omitempty: true Hostname: description: |- Hostname or IP Address of the syslog server where log should be stored. type: string x-omitempty: true MinSeverity: description: |- Lowest level of messages to be included in the remote log. * `warning` - Use logging level warning for logs classified as warning. * `emergency` - Use logging level emergency for logs classified as emergency. * `alert` - Use logging level alert for logs classified as alert. * `critical` - Use logging level critical for logs classified as critical. * `error` - Use logging level error for logs classified as error. * `notice` - Use logging level notice for logs classified as notice. * `informational` - Use logging level informational for logs classified as informational. * `debug` - Use logging level debug for logs classified as debug. type: string enum: - 'warning' - 'emergency' - 'alert' - 'critical' - 'error' - 'notice' - 'informational' - 'debug' default: warning x-omitempty: true Port: description: |- Port number used for logging on syslog server. type: integer format: int64 minimum: 1 maximum: 65535 x-omitempty: true Protocol: description: |- Transport layer protocol for transmission of log messages to syslog server. * `udp` - Use User Datagram Protocol (UDP) for syslog remote server connection. * `tcp` - Use Transmission Control Protocol (TCP) for syslog remote server connection. type: string enum: - 'udp' - 'tcp' default: udp x-omitempty: true syslog.RemoteLoggingClient: title: Remote Client description: |- Remote logging client for the endpoint. x-allOf-name: syslog.RemoteLoggingClient allOf: - # This 'syslog.RemoteLoggingClient' class inherits all properties from its parent class syslog.RemoteClientBase. $ref: '#/components/schemas/syslog.RemoteClientBase' tam.Action: title: Tam:Action description: |- An action is used to react when an object satifies the condition specified in alert query. For e.g. an action in case of an object matching a fieldNotice query would be to create an alert instance of type 'fieldNotice' for the affected object. x-allOf-name: tam.Action allOf: - # This 'tam.Action' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'tam.Action' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.Action', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.Action' ObjectType: enum: - 'tam.Action' AffectedObjectType: description: |- Type of the managed object that should be marked with an instance of the Alert (when operation type is create) or that should have an alert instance removed (when operation type is remove). type: string x-omitempty: true AlertType: description: |- Alert type is used to denote the category of an Intersight alert (FieldNotice, equipment Fault etc.). * `psirt` - Respresents the psirt alert type (https://tools.cisco.com/security/center/publicationListing.x). * `fieldNotice` - Respresents the field notice alert type (https://www.cisco.com/c/en/us/support/web/tsd-products-field-notice-summary.html). type: string enum: - 'psirt' - 'fieldNotice' default: psirt x-omitempty: true Identifiers: type: array items: description: |- Identifiers represents the filter criteria (property names and values) used to identify an Intersight managed object of type specified in affectedObjectType property. An instance of an alert is then create on (or removed from) the identified managed object. $ref: '#/components/schemas/tam.Identifiers' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Name: description: |- Uniquely identifies a given action among the set of actions corresponding to an advisory. Primarily used to store and compare results of subsequent iterations corresponding to the action queries. type: string x-omitempty: true OperationType: description: |- Operation type for the alert action. An action is used to carry out the process of "reacting" to an alert condition. For e.g.in case of a fieldNotice alert, the intention may be to create a new alert (if the condition matches and there is no existing alert) or to remove an existing alert when the alert condition has been remedied. * `create` - Create an instance of AdvisoryInstance. * `remove` - Remove an instance of AdvisoryInstance. type: string enum: - 'create' - 'remove' default: create x-omitempty: true Queries: type: array items: description: |- Set of SparkSQL queries used determine if a given alert is applicable or not. Refer to https://spark.apache.org/sql/ for more details. $ref: '#/components/schemas/tam.QueryEntry' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Type: description: |- Type of Intersight alert. An alert in Intersight could be one of several kinds (FieldNotice, PSIRT etc.). Primarily used for filtering alerts based on the type. * `restApi` - Repesents the use of REST API for carrying out alert actions. type: string enum: - 'restApi' default: restApi x-omitempty: true tam.AdvisoryCount.Response: description: |- The response body of a HTTP GET request for the 'tam.AdvisoryCount' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'tam.AdvisoryCount' resources. x-one-of-name: tam.AdvisoryCount.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/tam.AdvisoryCount.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType tam.AdvisoryCount: title: Tam:Advisory Count description: |- Total number of advisories currently affecting a given Account. x-allOf-name: tam.AdvisoryCount allOf: - # This 'tam.AdvisoryCount' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'tam.AdvisoryCount' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.AdvisoryCount', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.AdvisoryCount' ObjectType: enum: - 'tam.AdvisoryCount' AdvisoryCount: description: |- Total number of advisories affecting the account. type: integer format: int64 x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true tam.AdvisoryCount.List: title: List of 'tam.AdvisoryCount' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'tam.AdvisoryCount' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'tam.AdvisoryCount' resources matching the request. type: array items: $ref: '#/components/schemas/tam.AdvisoryCount' nullable: true tam.AdvisoryDefinition.Response: description: |- The response body of a HTTP GET request for the 'tam.AdvisoryDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'tam.AdvisoryDefinition' resources. x-one-of-name: tam.AdvisoryDefinition.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/tam.AdvisoryDefinition.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType tam.AdvisoryDefinition: title: Tam:Advisory Definition description: |- An Intersight Advisory. An advisory represents an identification of a potential issue and may also include a recommendation for resolving the said issue. Advisories may be of different kind and severity. for e.g. It could be a security vulnerability or a performance issue or a hardware issue with different recommendations for resolving them. x-allOf-name: tam.AdvisoryDefinition allOf: - # This 'tam.AdvisoryDefinition' class inherits all properties from its parent class tam.BaseAdvisory. $ref: '#/components/schemas/tam.BaseAdvisory' - # The definition of all the properties specified in this 'tam.AdvisoryDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.AdvisoryDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.AdvisoryDefinition' ObjectType: enum: - 'tam.AdvisoryDefinition' Actions: type: array items: description: |- An array of actions that are to be taken when a given managed object matches the criteria specified for being affected by an alert definition. $ref: '#/components/schemas/tam.Action' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AdvisoryDetails: description: |- Additional details for the advisory definition. For e.g. if the definition corresponds to a security advisory, the details regarding CVE ids and CVSS score would be available here. $ref: '#/components/schemas/tam.BaseAdvisoryDetails' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AdvisoryId: description: |- Cisco generated identifier for the published security advisory. type: string x-omitempty: true ApiDataSources: type: array items: description: |- An array of data sources that are used to provide data for queries used to identify an Intersight alert applicability. $ref: '#/components/schemas/tam.ApiDataSource' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true DatePublished: description: |- Date when the security advisory was first published by Cisco. type: string format: date-time x-omitempty: true DateUpdated: description: |- Date when the security advisory was last updated by Cisco. type: string format: date-time x-omitempty: true ExternalUrl: description: |- A link to an external URL describing security Advisory in more details. type: string pattern: "^$|^(?:http(s)?:\\/\\/)?[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$" x-omitempty: true Recommendation: description: |- Recommended action to resolve the security advisory. type: string x-omitempty: true Type: description: |- The type (field notice, security advisory etc.) of Intersight advisory. * `securityAdvisory` - Respresents the psirt alert type (https://tools.cisco.com/security/center/publicationListing.x). * `fieldNotice` - Respresents the field notice alert type (https://www.cisco.com/c/en/us/support/web/tsd-products-field-notice-summary.html). type: string enum: - 'securityAdvisory' - 'fieldNotice' default: securityAdvisory x-omitempty: true Version: description: |- Cisco assigned advisory version after latest revision. type: string x-omitempty: true Workaround: description: |- Workarounds available for the advisory. type: string x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true tam.AdvisoryDefinition.List: title: List of 'tam.AdvisoryDefinition' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'tam.AdvisoryDefinition' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'tam.AdvisoryDefinition' resources matching the request. type: array items: $ref: '#/components/schemas/tam.AdvisoryDefinition' nullable: true tam.AdvisoryInfo.Response: description: |- The response body of a HTTP GET request for the 'tam.AdvisoryInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'tam.AdvisoryInfo' resources. x-one-of-name: tam.AdvisoryInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/tam.AdvisoryInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType tam.AdvisoryInfo: title: Tam:Advisory Info description: |- State of an advisory in the context of a given account. Used to capture a given account's preferences regarding associated advisory. x-allOf-name: tam.AdvisoryInfo allOf: - # This 'tam.AdvisoryInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'tam.AdvisoryInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.AdvisoryInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.AdvisoryInfo' ObjectType: enum: - 'tam.AdvisoryInfo' State: description: |- Current state of the advisory for the owner. Indicates if the user is interested in getting updates for the advisory. * `active` - Advisory is currently active and the user wants to receive updates for this advisory. * `acknowledged` - Advisory is seen and acknowledged by the user and she no longer wants to recieve updates. type: string enum: - 'active' - 'acknowledged' default: active x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Advisory: # A Relationship to MO tam.BaseAdvisory $ref: '#/components/schemas/tam.BaseAdvisory.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a tamBaseAdvisory resource. When the $expand query parameter is specified, the referenced resource is returned inline. tam.AdvisoryInfo.List: title: List of 'tam.AdvisoryInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'tam.AdvisoryInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'tam.AdvisoryInfo' resources matching the request. type: array items: $ref: '#/components/schemas/tam.AdvisoryInfo' nullable: true tam.AdvisoryInstance.Response: description: |- The response body of a HTTP GET request for the 'tam.AdvisoryInstance' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'tam.AdvisoryInstance' resources. x-one-of-name: tam.AdvisoryInstance.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/tam.AdvisoryInstance.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType tam.AdvisoryInstance: title: Tam:Advisory Instance description: |- Instance of an Intersight advisory applicable for an Intersight managed object. An advisory instance is created when a given advisory is found applicable for an Intersight managed object. An advisory instance is retained for some time even after being cleared for historical purposes. A 'cleared' advisory instance is deleted after the retention time is elaspsed. x-allOf-name: tam.AdvisoryInstance allOf: - # This 'tam.AdvisoryInstance' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'tam.AdvisoryInstance' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.AdvisoryInstance', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.AdvisoryInstance' ObjectType: enum: - 'tam.AdvisoryInstance' AffectedObjectMoid: description: |- Moid of the Intersight MO affected by the alert. Deprecated now and will be removed in subsequent releases. type: string x-omitempty: true AffectedObjectType: description: |- Object type of the Intersight MO affected by the alert. Deprecated now and will be removed in subsequent releases. type: string x-omitempty: true LastStateChangeTime: description: |- Timestamp when a state change was observed on this advisory instnace. type: string format: date-time readOnly: true x-omitempty: true LastVerifiedTime: description: |- Timestamp when this advisory was last evaluated. type: string format: date-time readOnly: true x-omitempty: true State: description: |- Current state of the advisory instance (Active/Cleared/Unknown etc.). * `unknown` - Intersight is unable to determine if the Advisory instance is applicable for the affected managed object. * `active` - Advisory instance is currently active and applicable for the affected managed object. * `cleared` - Advisory instance is no longer applicable for the affected managed object. type: string enum: - 'unknown' - 'active' - 'cleared' default: unknown x-omitempty: true Advisory: # A Relationship to MO tam.BaseAdvisory $ref: '#/components/schemas/tam.BaseAdvisory.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a tamBaseAdvisory resource. When the $expand query parameter is specified, the referenced resource is returned inline. AffectedObject: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. DeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. tam.AdvisoryInstance.List: title: List of 'tam.AdvisoryInstance' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'tam.AdvisoryInstance' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'tam.AdvisoryInstance' resources matching the request. type: array items: $ref: '#/components/schemas/tam.AdvisoryInstance' nullable: true tam.ApiDataSource: title: Tam:Api Data Source description: |- Data source using Intersight API to collect data regarding managed devices. x-allOf-name: tam.ApiDataSource allOf: - # This 'tam.ApiDataSource' class inherits all properties from its parent class tam.BaseDataSource. $ref: '#/components/schemas/tam.BaseDataSource' - # The definition of all the properties specified in this 'tam.ApiDataSource' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.ApiDataSource', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.ApiDataSource' ObjectType: enum: - 'tam.ApiDataSource' MoType: description: |- Type of Intersight managed object used as data source. type: string x-omitempty: true Queries: type: array items: description: |- Optional set of Queries to filter the output for Api datasource. the queries are executed in the order specified. $ref: '#/components/schemas/tam.QueryEntry' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true tam.BaseAdvisory.Relationship: description: A relationship to the 'tam.BaseAdvisory' resource, or the expanded 'tam.BaseAdvisory' resource, or the 'null' value. x-one-of-name: tam.BaseAdvisory.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/tam.BaseAdvisory' tam.BaseAdvisory: title: Tam:Base Advisory description: |- An Intersight Advisory. An advisory represents an identification of a potential issue and may also include a recommendation for resolving the said issue. Advisories may be of different kind and severity. for e.g. It could be a security vulnerability or a performance issue or a hardware issue with different recommendations for resolving them. x-allOf-name: tam.BaseAdvisory allOf: - # This 'tam.BaseAdvisory' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'tam.BaseAdvisory' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.BaseAdvisory', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Brief description of the advisory details. type: string x-omitempty: true Name: description: |- A user defined name for the Intersight Advisory. type: string x-omitempty: true Severity: description: |- Severity level of the Intersight Advisory. $ref: '#/components/schemas/tam.Severity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true State: description: |- Current state of the advisory. * `ready` - Advisory has been evaluated. The affected devices would be analyzed and corresponding advisory instances would be created. * `evaluating` - Advisory is currently under evaluation. The affected devices would be analyzed but no advisory instances wouldbe created. The results of the analysis would be made available to Intersight engineering for evaluation and validation. type: string enum: - 'ready' - 'evaluating' default: ready x-omitempty: true tam.BaseAdvisoryDetails: title: Tam:Base Advisory Details description: |- Base type for specifying advisory type (Field notice, PSIRT) specific details. x-allOf-name: tam.BaseAdvisoryDetails allOf: - # This 'tam.BaseAdvisoryDetails' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'tam.BaseAdvisoryDetails' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.BaseAdvisoryDetails', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- Brief description of details specified for an advisory type. type: string x-omitempty: true tam.BaseDataSource: title: Tam:Base Data Source description: |- Represents source for the data needed to analyze the alerts. this could one of several supported source types (textFsmTemplates/Intersight API/external API). TextFsmTemplates and Intersight API are the only ones supported currently. x-allOf-name: tam.BaseDataSource allOf: - # This 'tam.BaseDataSource' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'tam.BaseDataSource' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.BaseDataSource', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Name: description: |- Name is used to unique identify and refer a given data source in an alert definition. type: string x-omitempty: true Type: description: |- Type of data source (for e.g. TextFsmTempalate based, Intersight API based etc.). * `nxos` - Collector type for this data collection is NXOS. * `intersightApi` - Collector type for this data collection is Intersight APIs. type: string enum: - 'nxos' - 'intersightApi' default: nxos x-omitempty: true tam.Identifiers: title: Tam:Identifiers description: |- Identifiers are used to identify an affected object in an alert defition. please refer to https://Intersight.com/apidocs/introduction/#get-requests-and-query-capabilities for more details. x-allOf-name: tam.Identifiers allOf: - # This 'tam.Identifiers' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'tam.Identifiers' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.Identifiers', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.Identifiers' ObjectType: enum: - 'tam.Identifiers' Name: description: |- Name of the filter paramter. type: string x-omitempty: true Value: description: |- Value of the filter paramter. type: string x-omitempty: true tam.PsirtSeverity: title: Tam:Psirt Severity description: |- < Severity level of a security advisory. Each advisory type (psirt/field notice etc.) may have a different method of calculating the severity. For e.g. a PSIRT severity may depend upon the corresponding CVSS score where as field notices are always critical in nature. x-allOf-name: tam.PsirtSeverity allOf: - # This 'tam.PsirtSeverity' class inherits all properties from its parent class tam.Severity. $ref: '#/components/schemas/tam.Severity' - # The definition of all the properties specified in this 'tam.PsirtSeverity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.PsirtSeverity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.PsirtSeverity' ObjectType: enum: - 'tam.PsirtSeverity' Level: description: |- Severity level associated with the security advisory. * `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. * `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. * `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. * `info` - < If applicable, it may have some minimal impact for certain functions in the user environment. For e.g. a PSIRT advisory with a corresponding CVSS score below 4.0. type: string enum: - 'critical' - 'high' - 'medium' - 'info' default: critical x-omitempty: true tam.QueryEntry: title: Tam:Query Entry description: |- Contains a set of queries, each with an integer priority. the queries are executed in the order of specified priority. The result of each query is used as an input to the query next in priority order. x-allOf-name: tam.QueryEntry allOf: - # This 'tam.QueryEntry' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'tam.QueryEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.QueryEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.QueryEntry' ObjectType: enum: - 'tam.QueryEntry' Name: description: |- Name is used to unique identify and result of the given query which can be used by subsequent queries as input data source. type: string x-omitempty: true Priority: description: |- An integer value depicting the priority of the query among the queries that are part of the same QueryEntry collection. type: integer format: int64 x-omitempty: true Query: description: |- A SparkSQL query to be used on a given data source. type: string x-omitempty: true tam.SecurityAdvisory.Response: description: |- The response body of a HTTP GET request for the 'tam.SecurityAdvisory' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'tam.SecurityAdvisory' resources. x-one-of-name: tam.SecurityAdvisory.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/tam.SecurityAdvisory.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType tam.SecurityAdvisory: title: Tam:Security Advisory description: |- Intersight representation of a Cisco PSIRT (https://tools.cisco.com/security/center/publicationListing.x) advisory definition. It includes the description of the security advisory and a corresponding reference to the published advisory. It also includes the Intersight data sources needed to evaluate the applicability of this advisory for relevant Intersight managed objects. A PSIRT definition is evaluated against all managed object referenced using the included data sources. Only Cisco TAC and Intersight devops engineers have the ability to create PSIRT definitions in Intersight. x-allOf-name: tam.SecurityAdvisory allOf: - # This 'tam.SecurityAdvisory' class inherits all properties from its parent class tam.BaseAdvisory. $ref: '#/components/schemas/tam.BaseAdvisory' - # The definition of all the properties specified in this 'tam.SecurityAdvisory' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.SecurityAdvisory', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.SecurityAdvisory' ObjectType: enum: - 'tam.SecurityAdvisory' Actions: type: array items: description: |- An array of actions that are to be taken when a given managed object matches the criteria specified for being affected by an alert definition. $ref: '#/components/schemas/tam.Action' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true AdvisoryId: description: |- Cisco generated identifier for the published security advisory. type: string x-omitempty: true ApiDataSources: type: array items: description: |- An array of data sources that are used to provide data for queries used to identify an Intersight alert applicability. $ref: '#/components/schemas/tam.ApiDataSource' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true BaseScore: description: |- CVSS version 3 base score for the security Advisory. type: number minimum: 0.0 maximum: 10.0 x-omitempty: true CveIds: type: array items: description: |- CVE (https://cve.mitre.org/about/faqs.html) identifiers associated with the published security Advisory. type: string pattern: "^$|CVE-[0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]+" x-omitempty: true DatePublished: description: |- Date when the security advisory was first published by Cisco. type: string format: date-time x-omitempty: true DateUpdated: description: |- Date when the security advisory was last updated by Cisco. type: string format: date-time x-omitempty: true EnvironmentalScore: description: |- CVSS version 3 environmental score for the security Advisory. type: number minimum: 0.0 maximum: 10.0 x-omitempty: true ExternalUrl: description: |- A link to an external URL describing security Advisory in more details. type: string pattern: "^$|^(?:http(s)?:\\/\\/)?[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$" x-omitempty: true Recommendation: description: |- Recommended action to resolve the security advisory. type: string x-omitempty: true Status: description: |- Cisco assigned status of the published advisory based on whether the investigation is complete or on-going. * `interim` - The Cisco investigation for the advisory is ongoing. Cisco will issue revisions to the advisory when additional information, including fixed software release data, becomes available. * `final` - Cisco has completed its evaluation of the vulnerability described in the advisory. There will be no further updates unless there is a material change in the nature of the vulnerability. type: string enum: - 'interim' - 'final' default: interim x-omitempty: true TemporalScore: description: |- CVSS version 3 temporal score for the security Advisory. type: number minimum: 0.0 maximum: 10.0 x-omitempty: true Version: description: |- Cisco assigned advisory version after latest revision. type: string x-omitempty: true Workaround: description: |- Workarounds available for the advisory. type: string x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true tam.SecurityAdvisory.List: title: List of 'tam.SecurityAdvisory' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'tam.SecurityAdvisory' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'tam.SecurityAdvisory' resources matching the request. type: array items: $ref: '#/components/schemas/tam.SecurityAdvisory' nullable: true tam.SecurityAdvisoryDetails: title: Tam:Security Advisory Details description: |- Details pertaining to a security advisory defined by a given advisory. x-allOf-name: tam.SecurityAdvisoryDetails allOf: - # This 'tam.SecurityAdvisoryDetails' class inherits all properties from its parent class tam.BaseAdvisoryDetails. $ref: '#/components/schemas/tam.BaseAdvisoryDetails' - # The definition of all the properties specified in this 'tam.SecurityAdvisoryDetails' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.SecurityAdvisoryDetails', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.SecurityAdvisoryDetails' ObjectType: enum: - 'tam.SecurityAdvisoryDetails' BaseScore: description: |- CVSS version 3 base score for the security Advisory. type: number minimum: 0.0 maximum: 10.0 x-omitempty: true CveIds: type: array items: description: |- CVE (https://cve.mitre.org/about/faqs.html) identifiers associated with the published security Advisory. type: string pattern: "^$|CVE-[0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]+" x-omitempty: true EnvironmentalScore: description: |- CVSS version 3 environmental score for the security Advisory. type: number minimum: 0.0 maximum: 10.0 x-omitempty: true Status: description: |- Cisco assigned status of the published advisory. Depends on whether the investigation is complete or on-going. * `interim` - The Cisco investigation for the advisory is ongoing. Cisco will issue revisions to the advisory when additional information, including fixed software release data, becomes available. * `final` - Cisco has completed its evaluation of the vulnerability described in the advisory. There will be no further updates unless there is a material change in the nature of the vulnerability. type: string enum: - 'interim' - 'final' default: interim x-omitempty: true TemporalScore: description: |- CVSS version 3 temporal score for the security Advisory. type: number minimum: 0.0 maximum: 10.0 x-omitempty: true tam.Severity: title: Tam:Severity description: |- < Severity associated with the advisory. Severity assignment and interpretation is specific to each type of advisory. Each advisory type (SecurityAdvisory etc.) is supposed to extend and implement Severity type based on the advisory type requirements. x-allOf-name: tam.Severity allOf: - # This 'tam.Severity' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' tam.TextFsmTemplateDataSource: title: Tam:Text Fsm Template Data Source description: |- TextFsmTemplate based data source used for data collection from the managed devices. x-allOf-name: tam.TextFsmTemplateDataSource allOf: - # This 'tam.TextFsmTemplateDataSource' class inherits all properties from its parent class tam.BaseDataSource. $ref: '#/components/schemas/tam.BaseDataSource' - # The definition of all the properties specified in this 'tam.TextFsmTemplateDataSource' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'tam.TextFsmTemplateDataSource', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'tam.TextFsmTemplateDataSource' ObjectType: enum: - 'tam.TextFsmTemplateDataSource' Cmd: description: |- Command used to gather data needed to evaluate field notice applicability. type: string x-omitempty: 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: - # This 'task.PureScopedInventory' class inherits all properties from its parent class connector.ScopedInventory. $ref: '#/components/schemas/connector.ScopedInventory' - # The definition of all the properties specified in this 'task.PureScopedInventory' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'task.PureScopedInventory', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'task.PureScopedInventory' ObjectType: enum: - 'task.PureScopedInventory' RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true techsupportmanagement.Download.Response: description: |- The response body of a HTTP GET request for the 'techsupportmanagement.Download' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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: - # This 'techsupportmanagement.Download' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'techsupportmanagement.Download' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'techsupportmanagement.Download', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'techsupportmanagement.Download' ObjectType: enum: - 'techsupportmanagement.Download' TechSupportStatus: # A Relationship to MO techsupportmanagement.TechSupportStatus $ref: '#/components/schemas/techsupportmanagement.TechSupportStatus.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a techsupportmanagementTechSupportStatus resource. When 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. The '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.NiaParam: title: Techsupportmanagement:Nia Param description: |- NIA parameter object for Tech Support requests. x-allOf-name: techsupportmanagement.NiaParam allOf: - # This 'techsupportmanagement.NiaParam' class inherits all properties from its parent class connector.PlatformParamBase. $ref: '#/components/schemas/connector.PlatformParamBase' - # The definition of all the properties specified in this 'techsupportmanagement.NiaParam' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'techsupportmanagement.NiaParam', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'techsupportmanagement.NiaParam' ObjectType: enum: - 'techsupportmanagement.NiaParam' CollectionLevel: description: |- CollectionLevel controls the size / depth of the tech support files collected. * `1` - Use cached data in the returned collection. * `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 Pids: type: array items: description: |- List of PIDs to collect from in the NIA environment. type: string x-omitempty: true SerialNumbers: type: array items: description: |- List of serial numbers to collect from in the NIA environment. type: string 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: - # This 'techsupportmanagement.PlatformParam' class inherits all properties from its parent class connector.PlatformParamBase. $ref: '#/components/schemas/connector.PlatformParamBase' - # The definition of all the properties specified in this 'techsupportmanagement.PlatformParam' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'techsupportmanagement.PlatformParam', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'techsupportmanagement.PlatformParam' ObjectType: enum: - 'techsupportmanagement.PlatformParam' CollectionType: description: |- CollectionType specifies if basic or detailed techsupport needs to be collected. * `1` - Collect basic techsupport. * `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. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' 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: - # This 'techsupportmanagement.TechSupportBundle' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'techsupportmanagement.TechSupportBundle' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'techsupportmanagement.TechSupportBundle', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'techsupportmanagement.TechSupportBundle' ObjectType: enum: - 'techsupportmanagement.TechSupportBundle' 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PlatformType: description: |- The platform type of the device. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' default: "" x-omitempty: true Serial: description: |- Serial number of the device. type: string x-omitempty: true DeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true TargetResource: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. TechSupportStatus: # A Relationship to MO techsupportmanagement.TechSupportStatus $ref: '#/components/schemas/techsupportmanagement.TechSupportStatus.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a techsupportmanagementTechSupportStatus resource. When 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. The '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.TechSupportStatus.Response: description: |- The response body of a HTTP GET request for the 'techsupportmanagement.TechSupportStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' techsupportmanagement.TechSupportStatus: title: Techsupportmanagement:Tech Support Status description: |- The techsupport collection status. x-allOf-name: techsupportmanagement.TechSupportStatus allOf: - # This 'techsupportmanagement.TechSupportStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'techsupportmanagement.TechSupportStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'techsupportmanagement.TechSupportStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'techsupportmanagement.TechSupportStatus' ObjectType: enum: - 'techsupportmanagement.TechSupportStatus' FileName: description: |- The name of the Techsupport bundle file. type: string x-omitempty: true Reason: description: |- Reason for techsupport failure, if any. type: string 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 x-omitempty: true Status: description: |- Status of techsupport collection. Valid values are Pending, CollectionInProgress, CollectionFailed, CollectionComplete, UploadPending, UploadInProgress, UploadPartsComplete, UploadFailed and Completed. The final status will be either CollectionFailed or UploadFailed if there is a failure and Completed if the request completed successfully and the file was uploaded to Intersight Storage Service. All the remaining status values indicates the progress of techsupport collection. type: string x-omitempty: true TechsupportDownloadUrl: description: |- The Url to download the techsupport file. type: string x-omitempty: true ClusterMember: # A Relationship to MO asset.ClusterMember $ref: '#/components/schemas/asset.ClusterMember.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetClusterMember resource. When the $expand query parameter is specified, the referenced resource is returned inline. DeviceRegistration: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. OriginResource: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. TechSupportRequest: # A Relationship to MO techsupportmanagement.TechSupportBundle $ref: '#/components/schemas/techsupportmanagement.TechSupportBundle.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a techsupportmanagementTechSupportBundle resource. When 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. The '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 terminal.AuditLog.Response: description: |- The response body of a HTTP GET request for the 'terminal.AuditLog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'terminal.AuditLog' resources. x-one-of-name: terminal.AuditLog.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/terminal.AuditLog.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType terminal.AuditLog: title: Terminal:Audit Log description: |- Audit log of remote terminal user sessions. x-allOf-name: terminal.AuditLog allOf: - # This 'terminal.AuditLog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'terminal.AuditLog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'terminal.AuditLog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'terminal.AuditLog' ObjectType: enum: - 'terminal.AuditLog' EndTime: description: |- The time the terminal was closed. If terminal has not closed, value is zero time. type: string format: date-time readOnly: true x-omitempty: true StartTime: description: |- The time the terminal session was opened. type: string format: date-time readOnly: true x-omitempty: true DeviceRegistration: # A Relationship to MO asset.DeviceConnection $ref: '#/components/schemas/asset.DeviceConnection.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceConnection resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true User: # A Relationship to MO iam.User $ref: '#/components/schemas/iam.User.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamUser resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true terminal.AuditLog.List: title: List of 'terminal.AuditLog' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'terminal.AuditLog' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'terminal.AuditLog' resources matching the request. type: array items: $ref: '#/components/schemas/terminal.AuditLog' nullable: true top.System.Response: description: |- The response body of a HTTP GET request for the 'top.System' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. 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' top.System: title: Top:System description: |- Root container for all UCSM / CIMC MOs. x-allOf-name: top.System allOf: - # This 'top.System' class inherits all properties from its parent class inventory.Base. $ref: '#/components/schemas/inventory.Base' - # The definition of all the properties specified in this 'top.System' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'top.System', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'top.System' ObjectType: enum: - 'top.System' 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: # A Relationship to MO compute.Blade description: An array of relationships to computeBlade resources. type: array items: $ref: '#/components/schemas/compute.Blade.Relationship' nullable: true ComputeRackUnits: # A Relationship to MO compute.RackUnit description: An array of relationships to computeRackUnit resources. type: array items: $ref: '#/components/schemas/compute.RackUnit.Relationship' nullable: true readOnly: true InventoryDeviceInfo: # A Relationship to MO inventory.DeviceInfo $ref: '#/components/schemas/inventory.DeviceInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a inventoryDeviceInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true ManagementController: # A Relationship to MO management.Controller $ref: '#/components/schemas/management.Controller.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a managementController resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true NetworkElements: # A Relationship to MO network.Element description: An array of relationships to networkElement resources. type: array items: $ref: '#/components/schemas/network.Element.Relationship' nullable: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When 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. The '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 ucsd.BackupInfo.Response: description: |- The response body of a HTTP GET request for the 'ucsd.BackupInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'ucsd.BackupInfo' resources. x-one-of-name: ucsd.BackupInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/ucsd.BackupInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType ucsd.BackupInfo: title: Ucsd:Backup Info description: |- List of backup images available for target end device for restore operation. x-allOf-name: ucsd.BackupInfo allOf: - # This 'ucsd.BackupInfo' class inherits all properties from its parent class recovery.AbstractBackupInfo. $ref: '#/components/schemas/recovery.AbstractBackupInfo' - # The definition of all the properties specified in this 'ucsd.BackupInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ucsd.BackupInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ucsd.BackupInfo' ObjectType: enum: - 'ucsd.BackupInfo' BackupFileName: description: |- Auto generated backup File Name with combination of file prefix given an user input and the timestamp. type: string readOnly: true x-omitempty: true BackupLocation: description: |- Backup location that contains the backup images for end device which can be used for restore operation. type: string readOnly: true x-omitempty: true BackupServerIp: description: |- Backup server where backup images are maintained. type: string readOnly: true x-omitempty: true BackupSize: description: |- Size of the backup image in bytes. type: integer format: int64 readOnly: true x-omitempty: true Connectors: type: array items: description: |- Connector pack versions that are active on the UCS Director when this backup image was taken. $ref: '#/components/schemas/ucsd.ConnectorPack' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Duration: description: |- Time taken for the backup to be completed. type: integer format: int64 readOnly: true x-omitempty: true EncryptionKey: description: |- The key used for encrypting the backup file. type: string writeOnly: true x-omitempty: true FailureReason: description: |- Reason for backup failure. type: string readOnly: true x-omitempty: true IsPurged: description: |- Backup image got purged or not. The backup images get purged based on the retention count set by the user in the backup config policy. type: boolean readOnly: true x-omitempty: true LastModified: description: |- Last modified time when this backup record got updated. type: string format: date-time readOnly: true x-omitempty: true PercentageCompletion: description: |- Backup current precentage completion status information. type: integer format: int64 readOnly: true x-omitempty: true ProductVersion: description: |- The end device product version when the backup image was taken. type: string x-omitempty: true Protocol: description: |- Protocol used for the remote backup. possible values are FTP, SCP and SFTP. Not applicable for the localhost (127.0.0.1). type: string readOnly: true x-omitempty: true StageCompletion: description: |- Backup current status stage information. type: string readOnly: true x-omitempty: true StartTime: description: |- Start time of backup when it got initiated. type: string format: date-time readOnly: true x-omitempty: true Status: description: |- Current status of Backup current. type: string readOnly: true x-omitempty: true ucsd.BackupInfo.List: title: List of 'ucsd.BackupInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'ucsd.BackupInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'ucsd.BackupInfo' resources matching the request. type: array items: $ref: '#/components/schemas/ucsd.BackupInfo' nullable: true ucsd.ConnectorPack: title: Ucsd:Connector Pack description: |- Information about the connector packs present in the backup file. x-allOf-name: ucsd.ConnectorPack allOf: - # This 'ucsd.ConnectorPack' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'ucsd.ConnectorPack' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ucsd.ConnectorPack', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ucsd.ConnectorPack' ObjectType: enum: - 'ucsd.ConnectorPack' ConnectorFeature: description: |- State of the connector pack whether it is enabled or disabled. type: string readOnly: true x-omitempty: true DependencyNames: type: array items: description: |- List of dependent connectors on the UCS Director for this connector. For example BigData depends on UCS Connector. type: string readOnly: true x-omitempty: true DownloadedVersion: description: |- Version of the connector pack that is last downloaded successfully to UCS Director. type: string readOnly: true x-omitempty: true Name: description: |- Name of the connector pack running on the UCS Director. type: string readOnly: true x-omitempty: true Services: type: array items: description: |- List of dependent connectors on the UCS Director for this connector. For example BigData depends on UCS Connector. type: string readOnly: true x-omitempty: true State: description: |- State of the connector pack whether it is enabled or disabled. type: string readOnly: true x-omitempty: true Version: description: |- Version of the connector pack. type: string readOnly: true x-omitempty: true ucsd.UcsdRestoreParameters: title: Ucsd:Ucsd Restore Parameters description: |- Restore Configuration Parameters for UCS Director restore workflow. x-allOf-name: ucsd.UcsdRestoreParameters allOf: - # This 'ucsd.UcsdRestoreParameters' class inherits all properties from its parent class recovery.ConfigParams. $ref: '#/components/schemas/recovery.ConfigParams' - # The definition of all the properties specified in this 'ucsd.UcsdRestoreParameters' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ucsd.UcsdRestoreParameters', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ucsd.UcsdRestoreParameters' ObjectType: enum: - 'ucsd.UcsdRestoreParameters' IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true Location: description: |- The complete location of the path on the server. The location should be specified in the following format- hostname-or-ipv4address<:port>/absolute-file-path. type: string x-omitempty: true Password: description: |- The password of the target backup server. Only required if the target server is accessed using SFTP or SCP protocol. type: string writeOnly: true x-omitempty: true Protocol: description: |- The protocol used to backup the UCS Director. type: string x-omitempty: true RestoreConfigurationFiles: description: |- Decides whether UCS Director property files should also be restored. type: boolean x-omitempty: true RestoreLicense: description: |- Decides whether license should also be restored. type: boolean x-omitempty: true Username: description: |- The username of the target backup server. Only required if the target server is accessed using SFTP or SCP protocol. type: string 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: - # This 'ucsdconnector.RestClientMessage' class inherits all properties from its parent class connector.AuthMessage. $ref: '#/components/schemas/connector.AuthMessage' - # The definition of all the properties specified in this 'ucsdconnector.RestClientMessage' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'ucsdconnector.RestClientMessage', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'ucsdconnector.RestClientMessage' ObjectType: enum: - 'ucsdconnector.RestClientMessage' 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. # Property is any value, it may be the null value, an object or array. 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 uuidpool.Block.Response: description: |- The response body of a HTTP GET request for the 'uuidpool.Block' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'uuidpool.Block' resources. x-one-of-name: uuidpool.Block.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/uuidpool.Block.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType uuidpool.Block.Relationship: description: A relationship to the 'uuidpool.Block' resource, or the expanded 'uuidpool.Block' resource, or the 'null' value. x-one-of-name: uuidpool.Block.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/uuidpool.Block' uuidpool.Block: title: Uuidpool:Block description: |- A block of contiguous UUID addresses that are part of a pool. x-allOf-name: uuidpool.Block allOf: - # This 'uuidpool.Block' class inherits all properties from its parent class pool.AbstractBlock. $ref: '#/components/schemas/pool.AbstractBlock' - # The definition of all the properties specified in this 'uuidpool.Block' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'uuidpool.Block', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'uuidpool.Block' ObjectType: enum: - 'uuidpool.Block' UuidSuffixBlock: description: |- A block of UUID addresses. $ref: '#/components/schemas/uuidpool.UuidBlock' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Pool: # A Relationship to MO uuidpool.Pool $ref: '#/components/schemas/uuidpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a uuidpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true uuidpool.Block.List: title: List of 'uuidpool.Block' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'uuidpool.Block' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'uuidpool.Block' resources matching the request. type: array items: $ref: '#/components/schemas/uuidpool.Block' nullable: true uuidpool.Pool.Response: description: |- The response body of a HTTP GET request for the 'uuidpool.Pool' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'uuidpool.Pool' resources. x-one-of-name: uuidpool.Pool.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/uuidpool.Pool.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType uuidpool.Pool.Relationship: description: A relationship to the 'uuidpool.Pool' resource, or the expanded 'uuidpool.Pool' resource, or the 'null' value. x-one-of-name: uuidpool.Pool.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/uuidpool.Pool' uuidpool.Pool: title: Uuidpool:Pool description: |- Pool represents a collection of UUID items that can be allocated to server profiles. x-allOf-name: uuidpool.Pool allOf: - # This 'uuidpool.Pool' class inherits all properties from its parent class pool.AbstractPool. $ref: '#/components/schemas/pool.AbstractPool' - # The definition of all the properties specified in this 'uuidpool.Pool' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'uuidpool.Pool', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'uuidpool.Pool' ObjectType: enum: - 'uuidpool.Pool' Prefix: description: |- The UUID prefix must be in hexadecimal format xxxxxxxx-xxxx-xxxx. type: string pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}$" x-createOnly: true x-omitempty: true UuidSuffixBlocks: type: array items: description: |- Collection of UUID suffix blocks. $ref: '#/components/schemas/uuidpool.UuidBlock' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true BlockHeads: # A Relationship to MO uuidpool.Block description: An array of relationships to uuidpoolBlock resources. type: array items: $ref: '#/components/schemas/uuidpool.Block.Relationship' nullable: true readOnly: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true uuidpool.Pool.List: title: List of 'uuidpool.Pool' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'uuidpool.Pool' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'uuidpool.Pool' resources matching the request. type: array items: $ref: '#/components/schemas/uuidpool.Pool' nullable: true uuidpool.PoolMember.Response: description: |- The response body of a HTTP GET request for the 'uuidpool.PoolMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'uuidpool.PoolMember' resources. x-one-of-name: uuidpool.PoolMember.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/uuidpool.PoolMember.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType uuidpool.PoolMember.Relationship: description: A relationship to the 'uuidpool.PoolMember' resource, or the expanded 'uuidpool.PoolMember' resource, or the 'null' value. x-one-of-name: uuidpool.PoolMember.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/uuidpool.PoolMember' uuidpool.PoolMember: title: Uuidpool:Pool Member description: |- PoolMember represents a single UUID that is part of a pool. x-allOf-name: uuidpool.PoolMember allOf: - # This 'uuidpool.PoolMember' class inherits all properties from its parent class pool.AbstractPoolMember. $ref: '#/components/schemas/pool.AbstractPoolMember' - # The definition of all the properties specified in this 'uuidpool.PoolMember' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'uuidpool.PoolMember', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'uuidpool.PoolMember' ObjectType: enum: - 'uuidpool.PoolMember' Uuid: description: |- UUID Prefix+Suffix of this PoolMember. type: string x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. BlockHead: # A Relationship to MO uuidpool.Block $ref: '#/components/schemas/uuidpool.Block.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a uuidpoolBlock resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Peer: # A Relationship to MO uuidpool.UuidLease $ref: '#/components/schemas/uuidpool.UuidLease.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a uuidpoolUuidLease resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Pool: # A Relationship to MO uuidpool.Pool $ref: '#/components/schemas/uuidpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a uuidpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true uuidpool.PoolMember.List: title: List of 'uuidpool.PoolMember' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'uuidpool.PoolMember' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'uuidpool.PoolMember' resources matching the request. type: array items: $ref: '#/components/schemas/uuidpool.PoolMember' nullable: true uuidpool.Universe.Response: description: |- The response body of a HTTP GET request for the 'uuidpool.Universe' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'uuidpool.Universe' resources. x-one-of-name: uuidpool.Universe.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/uuidpool.Universe.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType uuidpool.Universe.Relationship: description: A relationship to the 'uuidpool.Universe' resource, or the expanded 'uuidpool.Universe' resource, or the 'null' value. x-one-of-name: uuidpool.Universe.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/uuidpool.Universe' uuidpool.Universe: title: Uuidpool:Universe description: |- Universe represents a book keeping container to keep track of all UUIDs for a given account. x-allOf-name: uuidpool.Universe allOf: - # This 'uuidpool.Universe' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'uuidpool.Universe' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'uuidpool.Universe', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'uuidpool.Universe' ObjectType: enum: - 'uuidpool.Universe' Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true uuidpool.Universe.List: title: List of 'uuidpool.Universe' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'uuidpool.Universe' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'uuidpool.Universe' resources matching the request. type: array items: $ref: '#/components/schemas/uuidpool.Universe' nullable: true uuidpool.UuidBlock: title: Uuidpool:Uuid Block description: |- UUID suffix block representation. x-allOf-name: uuidpool.UuidBlock allOf: - # This 'uuidpool.UuidBlock' class inherits all properties from its parent class pool.AbstractBlockType. $ref: '#/components/schemas/pool.AbstractBlockType' - # The definition of all the properties specified in this 'uuidpool.UuidBlock' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'uuidpool.UuidBlock', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'uuidpool.UuidBlock' ObjectType: enum: - 'uuidpool.UuidBlock' From: description: |- Starting UUID suffix of the block must be in hexadecimal format xxxx-xxxxxxxxxxxx. type: string pattern: "^[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" x-omitempty: true To: description: |- Starting UUID suffix of the block must be in hexadecimal format xxxx-xxxxxxxxxxxx. type: string pattern: "^$|^[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" x-omitempty: true uuidpool.UuidLease.Response: description: |- The response body of a HTTP GET request for the 'uuidpool.UuidLease' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'uuidpool.UuidLease' resources. x-one-of-name: uuidpool.UuidLease.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/uuidpool.UuidLease.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType uuidpool.UuidLease.Relationship: description: A relationship to the 'uuidpool.UuidLease' resource, or the expanded 'uuidpool.UuidLease' resource, or the 'null' value. x-one-of-name: uuidpool.UuidLease.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/uuidpool.UuidLease' uuidpool.UuidLease: title: Uuidpool:Uuid Lease description: |- UuidLease represents a single UUID that is part of the universe, allocated either from a pool or through static assignment. x-allOf-name: uuidpool.UuidLease allOf: - # This 'uuidpool.UuidLease' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'uuidpool.UuidLease' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'uuidpool.UuidLease', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'uuidpool.UuidLease' ObjectType: enum: - 'uuidpool.UuidLease' Uuid: description: |- UUID Prefix+Suffix numbers. type: string pattern: "^$|^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" x-omitempty: true AssignedToEntity: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. Pool: # A Relationship to MO uuidpool.Pool $ref: '#/components/schemas/uuidpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a uuidpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true PoolMember: # A Relationship to MO uuidpool.PoolMember $ref: '#/components/schemas/uuidpool.PoolMember.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a uuidpoolPoolMember resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Universe: # A Relationship to MO uuidpool.Universe $ref: '#/components/schemas/uuidpool.Universe.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a uuidpoolUniverse resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true uuidpool.UuidLease.List: title: List of 'uuidpool.UuidLease' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'uuidpool.UuidLease' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'uuidpool.UuidLease' resources matching the request. type: array items: $ref: '#/components/schemas/uuidpool.UuidLease' nullable: true views.View: title: Views:View description: |- An abstract representation of a view. A view provides read-only access to the object model. A view can combine and transform data from multiple data sources. x-allOf-name: views.View allOf: - # This 'views.View' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' virtualization.BaseCluster: title: Virtualization: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: virtualization.BaseCluster allOf: - # This 'virtualization.BaseCluster' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'virtualization.BaseCluster' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.BaseCluster', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: HypervisorType: description: |- Identifies the broad type of the underlying hypervisor. * `Unknown` - The type of the hypervisor is unknown. * `ESXi` - A Vmware ESXi hypervisor of any version. * `HXAP` - A Cisco HyperFlex Application Platform hypervisor. type: string enum: - 'Unknown' - 'ESXi' - 'HXAP' default: Unknown x-omitempty: true Identity: description: |- The internally generated identity of this cluster. This entity is not manipulated by users. It aids in uniquely identifying the cluster object. In case of VMware, this is a MOR (managed object reference). type: string readOnly: true x-omitempty: true MemoryCapacity: description: |- The capacity and usage information for memory on this cluster. $ref: '#/components/schemas/virtualization.MemoryCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: 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 ProcessorCapacity: description: |- The capacity and usage information for CPU power on this cluster. $ref: '#/components/schemas/virtualization.ComputeCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Status: description: |- Cluster health status as reported by the hypervisor platform. * `Unknown` - Entity status is unknown. * `Degraded` - State is degraded, and might impact normal operation of the entity. * `Critical` - Entity is in a critical state, impacting operations. * `Ok` - Entity status is in a stable state, operating normally. type: string enum: - 'Unknown' - 'Degraded' - 'Critical' - 'Ok' default: Unknown readOnly: true x-omitempty: true TotalCores: description: |- Total number of CPU cores in this cluster. It is a cumulative number across all hosts in the cluster. type: integer format: int64 x-omitempty: true virtualization.BaseDatacenter: title: Virtualization:Base Datacenter description: |- Common attributes of any datacenter. Serves as a base class for all concrete hypervisor types. Datacenter (DC) is the container that brings together all other elements (Host, Datastore, Virtual Machine) A typical DC has datastores for storage for Virtual Machines, and a handful of hosts to run the Virtual Machines. In addition, there could be virtual switches and portgroups in those switches. x-allOf-name: virtualization.BaseDatacenter allOf: - # This 'virtualization.BaseDatacenter' class inherits all properties from its parent class virtualization.BaseSourceDevice. $ref: '#/components/schemas/virtualization.BaseSourceDevice' - # The definition of all the properties specified in this 'virtualization.BaseDatacenter' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.BaseDatacenter', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Identity: description: |- Internally generated identity of this datacenter. This entity is not manipulated by users. It aids in uniquely identifying the datacenter object. For VMware, this is a MOR (managed object reference). type: string readOnly: true x-omitempty: true Name: description: |- User provided name for the datacenter. Usually, this name is subject to manipulations by user. It is not the identity of the datacenter. type: string pattern: "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_-]{1,32}$" x-omitempty: true virtualization.BaseDatastore: title: Virtualization:Base Datastore description: |- Common attributes of a datastore allocated to a hypervisor. Serves as a base class for all concrete datastore types. A datastore is assigned to a datacenter and virtual machines use it for storage. The datastore could be backed by NFS, VMFS, etc. x-allOf-name: virtualization.BaseDatastore allOf: - # This 'virtualization.BaseDatastore' class inherits all properties from its parent class virtualization.BaseSourceDevice. $ref: '#/components/schemas/virtualization.BaseSourceDevice' - # The definition of all the properties specified in this 'virtualization.BaseDatastore' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.BaseDatastore', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Capacity: description: |- Storage utilization for this datastore. $ref: '#/components/schemas/virtualization.StorageCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true HostCount: description: |- Number of hosts attached to or supported-by this datastore. type: integer format: int64 x-omitempty: true Identity: description: |- The internally generated identity of this datastore. This entity is not manipulated by users. It aids in uniquely identifying the datastore object. For VMware, this is a MOR (managed object reference). type: string x-omitempty: true Name: description: |- Name of this datastore supplied by user. It is not the identity of the datastore. The name is subject to user manipulations. type: string x-omitempty: true Type: description: |- A string indicating the type of the datastore (VMFS, NFS, etc). * `Unknown` - The nature of the file system is unknown. * `VMFS` - It is a Virtual Machine Filesystem. * `NFS` - It is a Network File System. * `vSAN` - It is a virtual Storage Area Network file system. * `VirtualVolume` - A Virtual Volume datastore represents a storage container in a hypervisor server. type: string enum: - 'Unknown' - 'VMFS' - 'NFS' - 'vSAN' - 'VirtualVolume' default: Unknown x-omitempty: true VmCount: description: |- Number of virtual machines relying on (using) this datastore. type: integer format: int64 x-omitempty: true virtualization.BaseHost: title: Virtualization:Base Host description: |- Common attributes of any host associated to a hypervisor manager. Serves as a base class for all concrete host types A Host belongs to a datacenter and optionally to a cluster, and runs virtual machines on it. A host is basically a hardware platform that runs the VMs. Depending on the capacity of the host, it can support 100s of virtual machines. x-allOf-name: virtualization.BaseHost allOf: - # This 'virtualization.BaseHost' class inherits all properties from its parent class virtualization.BaseSourceDevice. $ref: '#/components/schemas/virtualization.BaseSourceDevice' - # The definition of all the properties specified in this 'virtualization.BaseHost' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.BaseHost', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: CpuInfo: description: |- Details about the CPUs installed on this host are represented here. $ref: '#/components/schemas/virtualization.CpuInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true HardwareInfo: description: |- The hardware details of this host. It includes capacity, manufacturer, and model information. $ref: '#/components/schemas/infra.HardwareInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true HypervisorType: description: |- Identifies the broad type of the underlying hypervisor. * `Unknown` - The type of the hypervisor is unknown. * `ESXi` - A Vmware ESXi hypervisor of any version. * `HXAP` - A Cisco HyperFlex Application Platform hypervisor. type: string enum: - 'Unknown' - 'ESXi' - 'HXAP' default: Unknown x-omitempty: true Identity: description: |- The internally generated identity of this host. This entity is not manipulated by users. It aids in uniquely identifying the datacenter object. For VMware, this is an MOR (managed object reference). type: string x-omitempty: true MaintenanceMode: description: |- Is this host in maintenance mode. Set to true or false. type: boolean x-omitempty: true MemoryCapacity: description: |- The memory capacity and usage information on this host. $ref: '#/components/schemas/virtualization.MemoryCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Model: description: |- Commercial model information about this hardware. type: string x-omitempty: true Name: description: |- Name of this host supplied by user. It is not the identity of the host. The name is subject to user manipulations. type: string x-omitempty: true ProcessorCapacity: description: |- The capacity and usage information for CPU power on this host. $ref: '#/components/schemas/virtualization.ComputeCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ProductInfo: description: |- Details of this product, such as vendor, model, etc. are represented here. $ref: '#/components/schemas/virtualization.ProductInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Serial: description: |- Serial number of this host (internally generated). type: string x-omitempty: true Status: description: |- Host health status, as reported by the hypervisor platform. * `Unknown` - Entity status is unknown. * `Degraded` - State is degraded, and might impact normal operation of the entity. * `Critical` - Entity is in a critical state, impacting operations. * `Ok` - Entity status is in a stable state, operating normally. type: string enum: - 'Unknown' - 'Degraded' - 'Critical' - 'Ok' default: Unknown x-omitempty: true UpTime: description: |- The uptime of the host, stored as Duration (from w3c). type: string x-omitempty: true Uuid: description: |- Universally unique identity of this host (example b3d4483b-5560-9342-8309-b486c9236610). Internally generated. type: string pattern: "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" x-omitempty: true Vendor: description: |- Commercial vendor details of this hardware. type: string x-omitempty: true virtualization.BaseHypervisorManager: title: Virtualization:Base Hypervisor Manager description: |- The basic hypervisor manager. Serves as a management layer for all hypervisors. A hypervisor manager contains datacenters, and datacenters contain all other entities such as Host, Portgroups, Virtual Machines, etc. x-allOf-name: virtualization.BaseHypervisorManager allOf: - # This 'virtualization.BaseHypervisorManager' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'virtualization.BaseHypervisorManager' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.BaseHypervisorManager', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Identity: description: |- Identity of the hypervisor (not manipulated by user). It could be a UUID too. For example, c917093f-5443-4748-bc09-eec72ded7608. type: string readOnly: true x-omitempty: true Name: description: |- The user provided name for the hypervisor manager. For example, vCenterIreland. Usually, this name is subject to manipulation by the user. It is not the identity of the hypervisor. type: string pattern: "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_-]{1,32}$" x-omitempty: true Version: description: |- Release version of the Hypervisor Manger (VMware vCenter Server 6.0.0 build-4541947). type: string readOnly: true x-omitempty: true RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. virtualization.BaseSourceDevice: title: Virtualization:Base Source Device description: |- Every inventory object comes from a device endpoint. The identity of that device is captured here so that any entity that needs to send a request to that device can use the inventory object to access it. x-allOf-name: virtualization.BaseSourceDevice allOf: - # This 'virtualization.BaseSourceDevice' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'virtualization.BaseSourceDevice' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.BaseSourceDevice', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: RegisteredDevice: # A Relationship to MO asset.DeviceRegistration $ref: '#/components/schemas/asset.DeviceRegistration.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a assetDeviceRegistration resource. When the $expand query parameter is specified, the referenced resource is returned inline. virtualization.BaseVirtualMachine: title: Virtualization:Base Virtual Machine description: |- Common attributes of a virtual machine managed by a hypervisor. Serves as a base class for all concrete virtual machine types. A virtual machine (VM) is what a user and applications interact with. A VM usually runs a guest OS and applications run on the guest OS. x-allOf-name: virtualization.BaseVirtualMachine allOf: - # This 'virtualization.BaseVirtualMachine' class inherits all properties from its parent class virtualization.BaseSourceDevice. $ref: '#/components/schemas/virtualization.BaseSourceDevice' - # The definition of all the properties specified in this 'virtualization.BaseVirtualMachine' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.BaseVirtualMachine', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Capacity: description: |- Provisioned CPU and memory information for this virtual machine. $ref: '#/components/schemas/infra.HardwareInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true GuestInfo: description: |- Guest operating system details running on this machine. $ref: '#/components/schemas/virtualization.GuestInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true HypervisorType: description: |- Type of hypervisor where the virtual machine is hosted for example ESXi. * `Unknown` - The type of the hypervisor is unknown. * `ESXi` - A Vmware ESXi hypervisor of any version. * `HXAP` - A Cisco HyperFlex Application Platform hypervisor. type: string enum: - 'Unknown' - 'ESXi' - 'HXAP' default: Unknown x-omitempty: true Identity: description: |- The internally generated identity of this VM. This entity is not manipulated by users. It aids in uniquely identifying the virtual machine object. For VMware, this is MOR (managed object reference). type: string x-omitempty: true IpAddress: type: array items: description: |- The IP address of the virtual machine. There could be multiple addresses of IPv4 and IPv6 types. type: string x-omitempty: true MemoryCapacity: description: |- The capacity and usage information for memory on this virtual machine. $ref: '#/components/schemas/virtualization.MemoryCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Name: description: |- User-provided name to identify the virtual machine. type: string x-omitempty: true PowerState: description: |- Power state of the virtual machine. * `Unknown` - The entity's power state is unknown. * `PoweredOn` - The entity is powered on. * `PoweredOff` - The entity is powered down. * `StandBy` - The entity is in standby mode. * `Paused` - The entity is in pause state. type: string enum: - 'Unknown' - 'PoweredOn' - 'PoweredOff' - 'StandBy' - 'Paused' default: Unknown x-omitempty: true ProcessorCapacity: description: |- The capacity and usage information for CPU power on this virtual machine. $ref: '#/components/schemas/virtualization.ComputeCapacity' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Uuid: description: |- The uuid of this virtual machine. The uuid is internally generated and not user specified. type: string pattern: "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" x-omitempty: true virtualization.ComputeCapacity: title: Virtualization:Compute Capacity description: |- Details of available CPU power across all cores and the free capacity still available. x-allOf-name: virtualization.ComputeCapacity allOf: - # This 'virtualization.ComputeCapacity' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.ComputeCapacity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.ComputeCapacity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.ComputeCapacity' ObjectType: enum: - 'virtualization.ComputeCapacity' Capacity: description: |- Total capacity of the entity in MHz. type: integer format: int64 x-omitempty: true Free: description: |- Free CPU capacity in MHz, as a point-in-time snapshot. The available CPU capacity is reported for an entity (such as Host or Cluster) when inventory data is collected for that entity. As part of the inventory data, a snapshot of the free and used CPU capacity is also reported. type: integer format: int64 x-omitempty: true Used: description: |- Used CPU capacity of the entity in MHz, as a point-in-time snapshot. type: integer format: int64 x-omitempty: true virtualization.CpuInfo: title: Virtualization:Cpu Info description: |- The details of the CPUs on this platform. x-allOf-name: virtualization.CpuInfo allOf: - # This 'virtualization.CpuInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.CpuInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.CpuInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.CpuInfo' ObjectType: enum: - 'virtualization.CpuInfo' Cores: description: |- Number of cores per CPU, as reported by the manufacturer. type: integer format: int64 x-omitempty: true Description: description: |- The vendor provided description of the CPU. For example, Intel Xeon E5-2640 v3 @ 2.60GHz. type: string x-omitempty: true Sockets: description: |- Number of CPU sockets available. type: integer format: int64 x-omitempty: true Speed: description: |- Speed of the CPUs in Hertz. For example, 2593749663. type: integer format: int64 x-omitempty: true Vendor: description: |- Manufacturer of the CPU . For example, Intel. type: string x-omitempty: true virtualization.GuestInfo: title: Virtualization:Guest Info description: |- Captures the common details of the guest personality that runs in a VM. x-allOf-name: virtualization.GuestInfo allOf: - # This 'virtualization.GuestInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.GuestInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.GuestInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.GuestInfo' ObjectType: enum: - 'virtualization.GuestInfo' Hostname: description: |- Name provided to the host OS (example, ubuntu6410, test-gateway, etc.). type: string x-omitempty: true IpAddress: description: |- Primary IP address of the guest os. type: string x-omitempty: true Name: description: |- The name of the guest running on this VM. This may not be the same as the hostname. type: string x-omitempty: true OperatingSystem: description: |- The name of the guest OS running on this VM (Cent OS 4/5/6/7). type: string x-omitempty: true virtualization.MemoryCapacity: title: Virtualization:Memory Capacity description: |- Measure of memory allocated and used. x-allOf-name: virtualization.MemoryCapacity allOf: - # This 'virtualization.MemoryCapacity' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.MemoryCapacity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.MemoryCapacity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.MemoryCapacity' ObjectType: enum: - 'virtualization.MemoryCapacity' Capacity: description: |- The total memory capacity of the entity in bytes. type: integer format: int64 x-omitempty: true Free: description: |- Free memory (bytes) that is unused and available for allocation, as a point-in-time snapshot. The available memory capacity is reported for an entity (such as Host or Cluster) when inventory data is collected for that entity. As part of the inventory data, a snapshot of the free and used memory capacity is also reported. type: integer format: int64 x-omitempty: true Used: description: |- Memory (bytes) that has been already used up, as a point-in-time snapshot. type: integer format: int64 x-omitempty: true virtualization.ProductInfo: title: Virtualization:Product Info description: |- The details of the product offering. x-allOf-name: virtualization.ProductInfo allOf: - # This 'virtualization.ProductInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.ProductInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.ProductInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.ProductInfo' ObjectType: enum: - 'virtualization.ProductInfo' ProductName: description: |- Commercial product name. For example, VMware ESXi. type: string x-omitempty: true ProductType: description: |- Product name provided by the vendor. For example, embeddedEsx. type: string x-omitempty: true ProductVendor: description: |- Commercial vendor name. For example, VMware Inc. type: string x-omitempty: true Version: description: |- Hypervisor version running on the system. type: string x-omitempty: true virtualization.StorageCapacity: title: Virtualization:Storage Capacity description: |- Captures the common attributes of a storage entity. x-allOf-name: virtualization.StorageCapacity allOf: - # This 'virtualization.StorageCapacity' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.StorageCapacity' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.StorageCapacity', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.StorageCapacity' ObjectType: enum: - 'virtualization.StorageCapacity' Capacity: description: |- The total capacity of the entity (bytes). type: integer format: int64 x-omitempty: true Free: description: |- Free storage space remaining in the entity (bytes) as a point-in-time snapshot. The available space is reported for an entity (such as Host or Cluster) when inventory data is collected for that entity. As part of the inventory data, a snapshot of the free and used storage capacity is also reported. type: integer format: int64 x-omitempty: true Used: description: |- Spaced already used by this entity (bytes), as a point-in-time snapshot. type: integer format: int64 x-omitempty: true virtualization.VmwareCluster.Response: description: |- The response body of a HTTP GET request for the 'virtualization.VmwareCluster' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'virtualization.VmwareCluster' resources. x-one-of-name: virtualization.VmwareCluster.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/virtualization.VmwareCluster.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType virtualization.VmwareCluster.Relationship: description: A relationship to the 'virtualization.VmwareCluster' resource, or the expanded 'virtualization.VmwareCluster' resource, or the 'null' value. x-one-of-name: virtualization.VmwareCluster.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/virtualization.VmwareCluster' virtualization.VmwareCluster: title: Virtualization:Vmware Cluster description: |- A real cluster of resources within a data center in VMware. A cluster is a convenient grouping of resources such as Host, Datastore, etc. x-allOf-name: virtualization.VmwareCluster allOf: - # This 'virtualization.VmwareCluster' class inherits all properties from its parent class virtualization.BaseCluster. $ref: '#/components/schemas/virtualization.BaseCluster' - # The definition of all the properties specified in this 'virtualization.VmwareCluster' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareCluster', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareCluster' ObjectType: enum: - 'virtualization.VmwareCluster' DatastoreCount: description: |- Count of all datastores associated with this cluster. type: integer format: int64 x-omitempty: true Datacenter: # A Relationship to MO virtualization.VmwareDatacenter $ref: '#/components/schemas/virtualization.VmwareDatacenter.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareDatacenter resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true virtualization.VmwareCluster.List: title: List of 'virtualization.VmwareCluster' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'virtualization.VmwareCluster' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'virtualization.VmwareCluster' resources matching the request. type: array items: $ref: '#/components/schemas/virtualization.VmwareCluster' nullable: true virtualization.VmwareDatacenter.Response: description: |- The response body of a HTTP GET request for the 'virtualization.VmwareDatacenter' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'virtualization.VmwareDatacenter' resources. x-one-of-name: virtualization.VmwareDatacenter.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/virtualization.VmwareDatacenter.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType virtualization.VmwareDatacenter.Relationship: description: A relationship to the 'virtualization.VmwareDatacenter' resource, or the expanded 'virtualization.VmwareDatacenter' resource, or the 'null' value. x-one-of-name: virtualization.VmwareDatacenter.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/virtualization.VmwareDatacenter' virtualization.VmwareDatacenter: title: Virtualization:Vmware Datacenter description: |- Datacenter object in VMware inventory. It is the logical container for all other objects like Datastore, Host, VirtualMachine, etc. x-allOf-name: virtualization.VmwareDatacenter allOf: - # This 'virtualization.VmwareDatacenter' class inherits all properties from its parent class virtualization.BaseDatacenter. $ref: '#/components/schemas/virtualization.BaseDatacenter' - # The definition of all the properties specified in this 'virtualization.VmwareDatacenter' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareDatacenter', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareDatacenter' ObjectType: enum: - 'virtualization.VmwareDatacenter' ClusterCount: description: |- Count of all clusters associated with this DC. type: integer format: int64 x-omitempty: true DatastoreCount: description: |- Count of all datastores associated with this DC. type: integer format: int64 x-omitempty: true HostCount: description: |- Count of all hosts associated with this DC. type: integer format: int64 x-omitempty: true NetworkCount: description: |- Count of all networks associated with this datacenter (DC). type: integer format: int64 x-omitempty: true VmCount: description: |- Count of all virtual machines (VMs) associated with this DC. type: integer format: int64 x-omitempty: true HypervisorManager: # A Relationship to MO virtualization.VmwareVcenter $ref: '#/components/schemas/virtualization.VmwareVcenter.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareVcenter resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true virtualization.VmwareDatacenter.List: title: List of 'virtualization.VmwareDatacenter' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'virtualization.VmwareDatacenter' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'virtualization.VmwareDatacenter' resources matching the request. type: array items: $ref: '#/components/schemas/virtualization.VmwareDatacenter' nullable: true virtualization.VmwareDatastore.Response: description: |- The response body of a HTTP GET request for the 'virtualization.VmwareDatastore' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'virtualization.VmwareDatastore' resources. x-one-of-name: virtualization.VmwareDatastore.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/virtualization.VmwareDatastore.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType virtualization.VmwareDatastore.Relationship: description: A relationship to the 'virtualization.VmwareDatastore' resource, or the expanded 'virtualization.VmwareDatastore' resource, or the 'null' value. x-one-of-name: virtualization.VmwareDatastore.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/virtualization.VmwareDatastore' virtualization.VmwareDatastore: title: Virtualization:Vmware Datastore description: |- The VMware Datastore entity with its attributes. Each Datastore belongs to a Datacenter and maybe attached to VMs. x-allOf-name: virtualization.VmwareDatastore allOf: - # This 'virtualization.VmwareDatastore' class inherits all properties from its parent class virtualization.BaseDatastore. $ref: '#/components/schemas/virtualization.BaseDatastore' - # The definition of all the properties specified in this 'virtualization.VmwareDatastore' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareDatastore', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareDatastore' ObjectType: enum: - 'virtualization.VmwareDatastore' Accessible: description: |- Shows if this datastore is accessible. type: boolean x-omitempty: true MaintenanceMode: description: |- Indicates if the datastore is in maintenance mode. Will be set to True, when in maintenance mode. type: boolean x-omitempty: true MultipleHostAccess: description: |- Indicates if this datastore is connected to multiple hosts. type: boolean x-omitempty: true Status: description: |- Datastore health status, as reported by the hypervisor platform. * `Unknown` - Entity status is unknown. * `Degraded` - State is degraded, and might impact normal operation of the entity. * `Critical` - Entity is in a critical state, impacting operations. * `Ok` - Entity status is in a stable state, operating normally. type: string enum: - 'Unknown' - 'Degraded' - 'Critical' - 'Ok' default: Unknown x-omitempty: true ThinProvisioningSupported: description: |- Indicates if this datastore supports thin provisioning for files. type: boolean x-omitempty: true UnCommitted: description: |- Space uncommitted in this datastore in bytes. type: integer format: int64 x-omitempty: true Url: description: |- The URL to access this datastore (example - 'ds:///vmfs/volumes/562a4e8a-0eeb5372-dd61-78baf9cb9afa/'). type: string x-omitempty: true Cluster: # A Relationship to MO virtualization.VmwareCluster $ref: '#/components/schemas/virtualization.VmwareCluster.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareCluster resource. When the $expand query parameter is specified, the referenced resource is returned inline. Datacenter: # A Relationship to MO virtualization.VmwareDatacenter $ref: '#/components/schemas/virtualization.VmwareDatacenter.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareDatacenter resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Hosts: # A Relationship to MO virtualization.VmwareHost description: An array of relationships to virtualizationVmwareHost resources. type: array items: $ref: '#/components/schemas/virtualization.VmwareHost.Relationship' nullable: true readOnly: true virtualization.VmwareDatastore.List: title: List of 'virtualization.VmwareDatastore' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'virtualization.VmwareDatastore' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'virtualization.VmwareDatastore' resources matching the request. type: array items: $ref: '#/components/schemas/virtualization.VmwareDatastore' nullable: true virtualization.VmwareHost.Response: description: |- The response body of a HTTP GET request for the 'virtualization.VmwareHost' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'virtualization.VmwareHost' resources. x-one-of-name: virtualization.VmwareHost.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/virtualization.VmwareHost.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType virtualization.VmwareHost.Relationship: description: A relationship to the 'virtualization.VmwareHost' resource, or the expanded 'virtualization.VmwareHost' resource, or the 'null' value. x-one-of-name: virtualization.VmwareHost.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/virtualization.VmwareHost' virtualization.VmwareHost: title: Virtualization:Vmware Host description: |- The VMware Host entity with its attributes. Every Host belongs to a Datacenter and may run VMs. x-allOf-name: virtualization.VmwareHost allOf: - # This 'virtualization.VmwareHost' class inherits all properties from its parent class virtualization.BaseHost. $ref: '#/components/schemas/virtualization.BaseHost' - # The definition of all the properties specified in this 'virtualization.VmwareHost' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareHost', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareHost' ObjectType: enum: - 'virtualization.VmwareHost' BootTime: description: |- The time when this host booted up. type: string format: date-time x-omitempty: true ConnectionState: description: |- Indicates if the host is connected to the vCenter. Values are connected, not connected. type: string x-omitempty: true HwPowerState: description: |- Is the host Powered-up or Powered-down. * `Unknown` - The entity's power state is unknown. * `PoweredOn` - The entity is powered on. * `PoweredOff` - The entity is powered down. * `StandBy` - The entity is in standby mode. * `Paused` - The entity is in pause state. type: string enum: - 'Unknown' - 'PoweredOn' - 'PoweredOff' - 'StandBy' - 'Paused' default: Unknown x-omitempty: true NetworkAdapterCount: description: |- The count of all network adapters attached to this host. type: integer format: int64 x-omitempty: true ResourceConsumed: description: |- Snapshot of resources (CPU, memory, etc.) consumed by this host. $ref: '#/components/schemas/virtualization.VmwareResourceConsumption' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true StorageAdapterCount: description: |- The count of all storage adapters attached to this host. type: integer format: int64 x-omitempty: true VcenterHostId: description: |- The identity of this host within vCenter (optional). type: string x-omitempty: true Cluster: # A Relationship to MO virtualization.VmwareCluster $ref: '#/components/schemas/virtualization.VmwareCluster.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareCluster resource. When the $expand query parameter is specified, the referenced resource is returned inline. Datacenter: # A Relationship to MO virtualization.VmwareDatacenter $ref: '#/components/schemas/virtualization.VmwareDatacenter.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareDatacenter resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Datastores: # A Relationship to MO virtualization.VmwareDatastore description: An array of relationships to virtualizationVmwareDatastore resources. type: array items: $ref: '#/components/schemas/virtualization.VmwareDatastore.Relationship' nullable: true readOnly: true virtualization.VmwareHost.List: title: List of 'virtualization.VmwareHost' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'virtualization.VmwareHost' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'virtualization.VmwareHost' resources matching the request. type: array items: $ref: '#/components/schemas/virtualization.VmwareHost' nullable: true virtualization.VmwareRemoteDisplayInfo: title: Virtualization:Vmware Remote Display Info description: |- Details of the remote display settings. x-allOf-name: virtualization.VmwareRemoteDisplayInfo allOf: - # This 'virtualization.VmwareRemoteDisplayInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.VmwareRemoteDisplayInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareRemoteDisplayInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareRemoteDisplayInfo' ObjectType: enum: - 'virtualization.VmwareRemoteDisplayInfo' RemoteDisplayPassword: description: |- The password used for remote access. It is stored base64 encoded. type: string x-omitempty: true RemoteDisplayVncKey: description: |- The access key for the remote display, potentially a long string. type: string x-omitempty: true RemoteDisplayVncPort: description: |- Applies only when remoteDisplayvnc is enabled. type: integer format: int64 x-omitempty: true virtualization.VmwareResourceConsumption: title: Virtualization:Vmware Resource Consumption description: |- Stats on the resources consumed by this host. x-allOf-name: virtualization.VmwareResourceConsumption allOf: - # This 'virtualization.VmwareResourceConsumption' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.VmwareResourceConsumption' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareResourceConsumption', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareResourceConsumption' ObjectType: enum: - 'virtualization.VmwareResourceConsumption' CpuConsumed: description: |- The amount of CPU consumed in Hz. type: integer format: int64 x-omitempty: true MemoryConsumed: description: |- Memory consumed by this host in bytes. type: integer format: int64 x-omitempty: true virtualization.VmwareVcenter.Response: description: |- The response body of a HTTP GET request for the 'virtualization.VmwareVcenter' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'virtualization.VmwareVcenter' resources. x-one-of-name: virtualization.VmwareVcenter.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/virtualization.VmwareVcenter.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType virtualization.VmwareVcenter.Relationship: description: A relationship to the 'virtualization.VmwareVcenter' resource, or the expanded 'virtualization.VmwareVcenter' resource, or the 'null' value. x-one-of-name: virtualization.VmwareVcenter.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/virtualization.VmwareVcenter' virtualization.VmwareVcenter: title: Virtualization:Vmware Vcenter description: |- VMware vCenter entity. The vCenter has a name assigned by user in Intersight. x-allOf-name: virtualization.VmwareVcenter allOf: - # This 'virtualization.VmwareVcenter' class inherits all properties from its parent class virtualization.BaseHypervisorManager. $ref: '#/components/schemas/virtualization.BaseHypervisorManager' virtualization.VmwareVcenter.List: title: List of 'virtualization.VmwareVcenter' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'virtualization.VmwareVcenter' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'virtualization.VmwareVcenter' resources matching the request. type: array items: $ref: '#/components/schemas/virtualization.VmwareVcenter' nullable: true virtualization.VmwareVirtualMachine.Response: description: |- The response body of a HTTP GET request for the 'virtualization.VmwareVirtualMachine' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'virtualization.VmwareVirtualMachine' resources. x-one-of-name: virtualization.VmwareVirtualMachine.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/virtualization.VmwareVirtualMachine.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType virtualization.VmwareVirtualMachine: title: Virtualization:Vmware Virtual Machine description: |- The VMware Virtual machine. It has details such as power state, IP address, resource consumption, etc. Basic elements come from the base class and VMware specific details are provided here. x-allOf-name: virtualization.VmwareVirtualMachine allOf: - # This 'virtualization.VmwareVirtualMachine' class inherits all properties from its parent class virtualization.BaseVirtualMachine. $ref: '#/components/schemas/virtualization.BaseVirtualMachine' - # The definition of all the properties specified in this 'virtualization.VmwareVirtualMachine' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareVirtualMachine', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareVirtualMachine' ObjectType: enum: - 'virtualization.VmwareVirtualMachine' Annotation: description: |- List of annotations provided to this VM by user. Can be long. type: string x-omitempty: true BootTime: description: |- Time when this VM booted up. type: string format: date-time x-omitempty: true ConfigName: description: |- The configuration name for this VM. This maybe the same as the guest hostname. type: string x-omitempty: true ConnectionState: description: |- Shows if virtual machine is connected to vCenter. Values are Connected, Disconnected, Orphaned, Inaccessible, and Invalid. type: string x-omitempty: true CpuHotAddEnabled: description: |- Indicates if the capability to add CPUs to a running VM is enabled. type: boolean x-omitempty: true CpuShares: description: |- Shows the relative importance of a VM and its CPU limits. $ref: '#/components/schemas/virtualization.VmwareVmCpuShareInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true CpuSocketInfo: description: |- Details of CPUs/sockets of this VM. $ref: '#/components/schemas/virtualization.VmwareVmCpuSocketInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true CustomAttributes: type: array items: description: |- User provided meta information associated with the VMs. Can be long. type: string x-omitempty: true DefaultPowerOffType: description: |- Indicates how the VM will be powered off (soft, hard etc.). type: string x-omitempty: true DhcpEnabled: description: |- Shows if DHCP is used for IP/DNS on this VM. type: boolean x-omitempty: true DiskCommitInfo: description: |- Information about the virtual machine's disk commits, sharing and limits. $ref: '#/components/schemas/virtualization.VmwareVmDiskCommitInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true DnsServerList: type: array items: description: |- List of DNS server IPs assigned to this VM. type: string x-omitempty: true DnsSuffixList: type: array items: description: |- List of DNS suffixes given to this VM. type: string x-omitempty: true Folder: description: |- The folder name associated with this VM. type: string x-omitempty: true GuestState: description: |- The state of the guest OS running on this VM. Could be running, not running etc. * `Unknown` - Indicates that the guest OS state cannot be determined. * `NotRunning` - Indicates that the guest OS is not running. * `Resetting` - Indicates that the guest OS is resetting. * `Running` - Indicates that the guest OS is running normally. * `ShuttingDown` - Indicates that the guest OS is shutting down. * `Standby` - Indicates that the guest OS is in standby mode. type: string enum: - 'Unknown' - 'NotRunning' - 'Resetting' - 'Running' - 'ShuttingDown' - 'Standby' default: Unknown x-omitempty: true InstanceUuid: description: |- UUID assigned by vCenter to every VM. type: string pattern: "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" x-omitempty: true IsTemplate: description: |- If true, indicates that the entity refers to a template of a virtual machine and not a real virtual machine. type: boolean x-omitempty: true MacAddress: type: array items: description: |- Standard MAC address assigned to this VM. type: string x-omitempty: true MemShares: description: |- Similar to CPU Shares but applicable to memory. $ref: '#/components/schemas/virtualization.VmwareVmMemoryShareInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MemoryHotAddEnabled: description: |- Adding memory to a running VM. type: boolean x-omitempty: true NetworkCount: description: |- Indicates how many networks are used by this VM. type: integer format: int64 x-omitempty: true PortGroups: type: array items: description: |- List of portgroup names allocated to this VM. type: string x-omitempty: true ProtectedVm: description: |- Shows if this is a protected VM. VMs can be in protection groups. type: boolean x-omitempty: true RemoteDisplayInfo: description: |- Applies only when remoteDisplayvnc is enabled. $ref: '#/components/schemas/virtualization.VmwareRemoteDisplayInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true RemoteDisplayVncEnabled: description: |- Shows if support for a remote VNC access is enabled. type: boolean x-omitempty: true ResourcePool: description: |- Name of the resource pool to which this VM belongs (optional). type: string x-omitempty: true ResourcePoolOwner: description: |- Who owns the resource pool. type: string x-omitempty: true ResourcePoolParent: description: |- The parent of the current resource pool to which this VM belongs. type: string x-omitempty: true ToolRunningStatus: description: |- Indicates if guest tools are running on this VM. Could be set to guestToolNotRunning or guestToolsRunning. type: string x-omitempty: true ToolsVersion: description: |- The version of the guest tools, usually not specified. type: string x-omitempty: true VmDiskCount: description: |- Shows the number of disks assigned to this VM. type: integer format: int64 x-omitempty: true VmOverallStatus: description: |- The operational state of the VM. Could be Available, Provisioned, Maintenance mode, Deleting, etc. type: string x-omitempty: true VmPath: description: |- Example - [datastore3] VCSA-134/VCSA-134.vmx. type: string x-omitempty: true VmVersion: description: |- Information about the version of this VM (vmx-09, vmx-11 etc.). type: string x-omitempty: true VmVnicCount: description: |- How many vnics are present. type: integer format: int64 x-omitempty: true VnicDeviceConfigId: description: |- Information related to the guest info's VNIC virtual device. It is a comma-separated list. type: string x-omitempty: true Cluster: # A Relationship to MO virtualization.VmwareCluster $ref: '#/components/schemas/virtualization.VmwareCluster.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareCluster resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Datacenter: # A Relationship to MO virtualization.VmwareDatacenter $ref: '#/components/schemas/virtualization.VmwareDatacenter.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareDatacenter resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Datastores: # A Relationship to MO virtualization.VmwareDatastore description: An array of relationships to virtualizationVmwareDatastore resources. type: array items: $ref: '#/components/schemas/virtualization.VmwareDatastore.Relationship' nullable: true readOnly: true Host: # A Relationship to MO virtualization.VmwareHost $ref: '#/components/schemas/virtualization.VmwareHost.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a virtualizationVmwareHost resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true virtualization.VmwareVirtualMachine.List: title: List of 'virtualization.VmwareVirtualMachine' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'virtualization.VmwareVirtualMachine' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'virtualization.VmwareVirtualMachine' resources matching the request. type: array items: $ref: '#/components/schemas/virtualization.VmwareVirtualMachine' nullable: true virtualization.VmwareVmCpuShareInfo: title: Virtualization:Vmware Vm Cpu Share Info description: |- Information about the virtual machine's CPU sharing and limits. x-allOf-name: virtualization.VmwareVmCpuShareInfo allOf: - # This 'virtualization.VmwareVmCpuShareInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.VmwareVmCpuShareInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareVmCpuShareInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareVmCpuShareInfo' ObjectType: enum: - 'virtualization.VmwareVmCpuShareInfo' CpuLimit: description: |- Upper limit on CPU allocation (MHz). type: integer format: int64 x-omitempty: true CpuOverheadLimit: description: |- Amount of CPU for virtualization overhead. type: integer format: int64 x-omitempty: true CpuReservation: description: |- Guaranteed minimum allocation of CPU resource (MHz). type: integer format: int64 x-omitempty: true CpuShares: description: |- Shows the relative importance of a VM. There is no unit for this value. It is a relative measure based on the settings for other resource pools. For more information, see VMware documentation. type: integer format: int64 x-omitempty: true virtualization.VmwareVmCpuSocketInfo: title: Virtualization:Vmware Vm Cpu Socket Info description: |- Information about the virtual machine's hardware platform (CPU, memory). x-allOf-name: virtualization.VmwareVmCpuSocketInfo allOf: - # This 'virtualization.VmwareVmCpuSocketInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.VmwareVmCpuSocketInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareVmCpuSocketInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareVmCpuSocketInfo' ObjectType: enum: - 'virtualization.VmwareVmCpuSocketInfo' CoresPerSocket: description: |- The number of core per CPU socket (value may be empty). type: integer format: int64 x-omitempty: true NumCpus: description: |- Number of CPUs allocated to this VM. type: integer format: int64 x-omitempty: true NumSockets: description: |- The number of CPU sockets allocated. type: integer format: int64 x-omitempty: true virtualization.VmwareVmDiskCommitInfo: title: Virtualization:Vmware Vm Disk Commit Info description: |- Information about the virtual machine's disk commits, sharing and limits. For more information, see VMware documentation. x-allOf-name: virtualization.VmwareVmDiskCommitInfo allOf: - # This 'virtualization.VmwareVmDiskCommitInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.VmwareVmDiskCommitInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareVmDiskCommitInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareVmDiskCommitInfo' ObjectType: enum: - 'virtualization.VmwareVmDiskCommitInfo' CommittedDisk: description: |- Disk committed in bytes on this virtual machine (disk space used up). type: integer format: int64 x-omitempty: true UnCommittedDisk: description: |- Total uncommitted disk space that is available for use (in bytes). type: integer format: int64 x-omitempty: true UnsharedDisk: description: |- Total unshared disk space (in bytes). type: integer format: int64 x-omitempty: true virtualization.VmwareVmMemoryShareInfo: title: Virtualization:Vmware Vm Memory Share Info description: |- Information about the virtual machine's memory sharing and limits. For more information, see VMware documentation. x-allOf-name: virtualization.VmwareVmMemoryShareInfo allOf: - # This 'virtualization.VmwareVmMemoryShareInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'virtualization.VmwareVmMemoryShareInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'virtualization.VmwareVmMemoryShareInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'virtualization.VmwareVmMemoryShareInfo' ObjectType: enum: - 'virtualization.VmwareVmMemoryShareInfo' MemLimit: description: |- Limit on the memory sharing imposed (in Mbytes). type: integer format: int64 x-omitempty: true MemOverheadLimit: description: |- Limit on memory overhead imposed (in Mbytes). type: integer format: int64 x-omitempty: true MemReservation: description: |- Similar to CPU reservations (Mbytes). type: integer format: int64 x-omitempty: true MemShares: description: |- Similar to CPU Shares but applicable to memory. There is no unit for this value. It is a relative measure based on the settings for other resource pools. type: integer format: int64 x-omitempty: true vmedia.Mapping: title: Vmedia:Mapping description: |- Virtual Media mapping settings required to map images from remote server. x-allOf-name: vmedia.Mapping allOf: - # This 'vmedia.Mapping' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vmedia.Mapping' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vmedia.Mapping', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vmedia.Mapping' ObjectType: enum: - 'vmedia.Mapping' AuthenticationProtocol: description: |- Type of Authentication protocol when CIFS is used for communication with the remote server. * `none` - No authentication is used. * `ntlm` - NT LAN Manager (NTLM) security protocol. Use this option only with Windows 2008 R2 and Windows 2012 R2. * `ntlmi` - NTLMi security protocol. Use this option only when you enable Digital Signing in the CIFS Windows server. * `ntlmv2` - NTLMv2 security protocol. Use this option only with Samba Linux. * `ntlmv2i` - NTLMv2i security protocol. Use this option only with Samba Linux. * `ntlmssp` - NT LAN Manager Security Support Provider (NTLMSSP) protocol. Use this option only with Windows 2008 R2 and Windows 2012 R2. * `ntlmsspi` - NTLMSSPi protocol. Use this option only when you enable Digital Signing in the CIFS Windows server. type: string enum: - 'none' - 'ntlm' - 'ntlmi' - 'ntlmv2' - 'ntlmv2i' - 'ntlmssp' - 'ntlmsspi' default: none x-omitempty: true DeviceType: description: |- Type of remote Virtual Media device. * `cdd` - Uses compact disc drive as the virtual media mount device. * `hdd` - Uses hard disk drive as the virtual media mount device. type: string enum: - 'cdd' - 'hdd' default: cdd x-omitempty: true HostName: description: |- IP address or hostname of the remote server. type: string x-omitempty: true IsPasswordSet: description: |- Indicates whether the value of the 'password' property has been set. type: boolean readOnly: true x-omitempty: true MountOptions: description: |- Mount options for the Virtual Media mapping. The field can be left blank or filled in a comma separated list with the following options.\n For NFS, supported options are ro, rw, nolock, noexec, soft, port=VALUE, timeo=VALUE, retry=VALUE.\n For CIFS, supported options are soft, nounix, noserverino, guest.\n For CIFS version < 3.0, vers=VALUE is mandatory. e.g. vers=2.0\n For HTTP/HTTPS, the only supported option is noauto. type: string minLength: 0 maxLength: 248 x-omitempty: true MountProtocol: description: |- Protocol to use to communicate with the remote server. * `nfs` - NFS protocol for vmedia mount. * `cifs` - CIFS protocol for vmedia mount. * `http` - HTTP protocol for vmedia mount. * `https` - HTTPS protocol for vmedia mount. type: string enum: - 'nfs' - 'cifs' - 'http' - 'https' default: nfs x-omitempty: true Password: description: |- Password associated with the username. type: string minLength: 0 maxLength: 255 writeOnly: true x-omitempty: true RemoteFile: description: |- Name of the remote file. It should be of .img format for HDD Virtual Media mapping and .iso format for CDD Virtual Media mapping. type: string pattern: "^[ !#$%\\(\\)\\+,\\-\\.:\\?@\\[\\]_\\{\\}=~a-zA-Z0-9]+$" minLength: 1 maxLength: 235 x-omitempty: true RemotePath: description: |- URL path to the location of the image on the remote server. The preferred format is '/path'. type: string pattern: "^[ !#$%\\(\\)\\+,\\-\\.\\/:\\?@\\[\\]_\\{\\}=~a-zA-Z0-9]+$" x-omitempty: true Username: description: |- Username to log in to the remote server. type: string minLength: 0 maxLength: 255 x-omitempty: true VolumeName: description: |- Identity of the image for Virtual Media mapping. type: string pattern: "^[\\-\\.:_a-zA-Z0-9]+$" minLength: 1 maxLength: 47 x-omitempty: true vmedia.Policy.Response: description: |- The response body of a HTTP GET request for the 'vmedia.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vmedia.Policy' resources. x-one-of-name: vmedia.Policy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vmedia.Policy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vmedia.Policy: title: Virtual Media description: |- Policy to configure virtual media settings on endpoint. x-allOf-name: vmedia.Policy allOf: - # This 'vmedia.Policy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vmedia.Policy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vmedia.Policy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vmedia.Policy' ObjectType: enum: - 'vmedia.Policy' Enabled: description: |- State of the Virtual Media service on the endpoint. type: boolean x-omitempty: true Encryption: description: |- If enabled, allows encryption of all Virtual Media communications. type: boolean x-omitempty: true LowPowerUsb: description: |- If enabled, the virtual drives appear on the boot selection menu after mapping the image and rebooting the host. type: boolean x-omitempty: true Mappings: type: array items: description: |- Adds a new Virtual Media mapping for images. $ref: '#/components/schemas/vmedia.Mapping' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true vmedia.Policy.List: title: List of 'vmedia.Policy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vmedia.Policy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vmedia.Policy' resources matching the request. type: array items: $ref: '#/components/schemas/vmedia.Policy' nullable: true vnic.ArfsSettings: title: ARFS Settings description: |- Settings for Accelerated Receive Flow Steering to reduce the network latency and increase CPU cache efficiency. x-allOf-name: vnic.ArfsSettings allOf: - # This 'vnic.ArfsSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.ArfsSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.ArfsSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.ArfsSettings' ObjectType: enum: - 'vnic.ArfsSettings' Enabled: description: |- Status of Accelerated Receive Flow Steering on the virtual ethernet interface. type: boolean x-omitempty: true vnic.Cdn: title: Consistent Device Naming description: |- Consistent Device Naming configuration for the virtual NIC. x-allOf-name: vnic.Cdn allOf: - # This 'vnic.Cdn' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.Cdn' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.Cdn', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.Cdn' ObjectType: enum: - 'vnic.Cdn' Source: description: |- Source of the CDN. It can either be user specified or be the same as the vNIC name. * `vnic` - Source of the CDN is the same as the vNIC name. * `user` - Source of the CDN is specified by the user. type: string enum: - 'vnic' - 'user' default: vnic x-omitempty: true Value: description: |- The CDN value entered in case of user defined mode. type: string pattern: "^[a-zA-Z0-9\\-\\._:]*$" maxLength: 31 x-omitempty: true vnic.CompletionQueueSettings: title: Completion Queue Settings description: |- Completion Queue resource settings. x-allOf-name: vnic.CompletionQueueSettings allOf: - # This 'vnic.CompletionQueueSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.CompletionQueueSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.CompletionQueueSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.CompletionQueueSettings' ObjectType: enum: - 'vnic.CompletionQueueSettings' Count: description: |- The number of completion queue resources to allocate. In general, the number of completion queue resources to allocate is equal to the number of transmit queue resources plus the number of receive queue resources. type: integer format: int64 minimum: 1 maximum: 512 x-omitempty: true RingSize: description: |- The number of descriptors in each completion queue. type: integer format: int64 minimum: 1 maximum: 1 readOnly: true x-omitempty: true vnic.EthAdapterPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.EthAdapterPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.EthAdapterPolicy' resources. x-one-of-name: vnic.EthAdapterPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.EthAdapterPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.EthAdapterPolicy.Relationship: description: A relationship to the 'vnic.EthAdapterPolicy' resource, or the expanded 'vnic.EthAdapterPolicy' resource, or the 'null' value. x-one-of-name: vnic.EthAdapterPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.EthAdapterPolicy' vnic.EthAdapterPolicy: title: Ethernet Adapter description: |- An Ethernet adapter policy governs the host-side behavior of the adapter, including how the adapter handles traffic. For each VIC Virtual Ethernet Interface various features like VXLAN, NVGRE, ARFS, Interrupt settings, and TCP Offload settings can be configured. x-allOf-name: vnic.EthAdapterPolicy allOf: - # This 'vnic.EthAdapterPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.EthAdapterPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.EthAdapterPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.EthAdapterPolicy' ObjectType: enum: - 'vnic.EthAdapterPolicy' AdvancedFilter: description: |- Enables advanced filtering on the interface. type: boolean x-omitempty: true ArfsSettings: description: |- Settings for Accelerated Receive Flow Steering to reduce the network latency and increase CPU cache efficiency. $ref: '#/components/schemas/vnic.ArfsSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true CompletionQueueSettings: description: |- Completion Queue resource settings. $ref: '#/components/schemas/vnic.CompletionQueueSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true InterruptScaling: description: |- Enables Interrupt Scaling on the interface. type: boolean x-omitempty: true InterruptSettings: description: |- Interrupt Settings for the virtual ethernet interface. $ref: '#/components/schemas/vnic.EthInterruptSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true NvgreSettings: description: |- Network Virtualization using Generic Routing Encapsulation Settings. $ref: '#/components/schemas/vnic.NvgreSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true RoceSettings: description: |- Settings for RDMA over Converged Ethernet. $ref: '#/components/schemas/vnic.RoceSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true RssHashSettings: description: |- Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores. $ref: '#/components/schemas/vnic.RssHashSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true RssSettings: description: |- Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores. type: boolean x-omitempty: true RxQueueSettings: description: |- Receive Queue resouce settings. $ref: '#/components/schemas/vnic.EthRxQueueSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true TcpOffloadSettings: description: |- The TCP offload settings decide whether to offload the TCP related network functions from the CPU to the network hardware or not. $ref: '#/components/schemas/vnic.TcpOffloadSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true TxQueueSettings: description: |- Transmit Queue resource settings. $ref: '#/components/schemas/vnic.EthTxQueueSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true UplinkFailbackTimeout: description: |- Uplink Failback Timeout in seconds when uplink failover is enabled for a vNIC. After a vNIC has started using its secondary interface, this setting controls how long the primary interface must be available before the system resumes using the primary interface for the vNIC. type: integer format: int64 minimum: 0 maximum: 600 x-omitempty: true VxlanSettings: description: |- Virtual Extensible LAN Protocol Settings. $ref: '#/components/schemas/vnic.VxlanSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true vnic.EthAdapterPolicy.List: title: List of 'vnic.EthAdapterPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.EthAdapterPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.EthAdapterPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.EthAdapterPolicy' nullable: true vnic.EthIf.Response: description: |- The response body of a HTTP GET request for the 'vnic.EthIf' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.EthIf' resources. x-one-of-name: vnic.EthIf.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.EthIf.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.EthIf.Relationship: description: A relationship to the 'vnic.EthIf' resource, or the expanded 'vnic.EthIf' resource, or the 'null' value. x-one-of-name: vnic.EthIf.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.EthIf' vnic.EthIf: title: Virtual Ethernet Interface description: |- Virtual Ethernet Interface. x-allOf-name: vnic.EthIf allOf: - # This 'vnic.EthIf' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'vnic.EthIf' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.EthIf', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.EthIf' ObjectType: enum: - 'vnic.EthIf' Cdn: description: |- Consistent Device Naming configuration for the virtual NIC. $ref: '#/components/schemas/vnic.Cdn' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true FailoverEnabled: description: |- Setting this to true esnures that the traffic failsover from one uplink to another auotmatically in case of an uplink failure. It is applicable for Cisco VIC adapters only which are connected to Fabric Interconnect cluster. The uplink if specified determines the primary uplink in case of a failover. type: boolean x-omitempty: true MacAddress: description: |- The MAC address that is assigned to the vnic based on the MAC pool that has been assigned to the LAN Connectivity Policy. type: string readOnly: true x-omitempty: true Name: description: |- Name of the virtual ethernet interface. type: string pattern: "^[a-zA-Z0-9-._:]*$" maxLength: 31 x-omitempty: true Order: description: |- The order in which the virtual interface is brought up. The order assigned to an interface should be unique for all the Ethernet and Fibre-Channel interfaces on each PCI link on a VIC adapter. The maximum value of PCI order is limited by the number of virtual interfaces (Ethernet and Fibre-Channel) on each PCI link on a VIC adapter. All VIC adapters have a single PCI link except VIC 1385 which has two. type: integer format: int64 x-omitempty: true Placement: description: |- Placement Settings for the virtual interface. $ref: '#/components/schemas/vnic.PlacementSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true StandbyVifId: description: |- The Standby VIF Id is applicable for failover enabled vNICS. It should be the same as the channel number of the standby vethernet created on switch in order to set up the standby data path. type: integer format: int64 readOnly: true x-omitempty: true UsnicSettings: description: |- User Space NIC Settings that enable low-latency and higher throughput by bypassing the kernel layer when sending/receiving packets. $ref: '#/components/schemas/vnic.UsnicSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true VifId: description: |- The Vif Id should be same as the channel number of the vethernet created on switch in order to set up the data path. The property is applicable only for FI attached servers where a vethernet is created on the switch for every vNIC. type: integer format: int64 readOnly: true x-omitempty: true VmqSettings: description: |- Virtual Machine Queue Settings for the virtual interface that allow efficient transfer of network traffic to the guest OS. $ref: '#/components/schemas/vnic.VmqSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true EthAdapterPolicy: # A Relationship to MO vnic.EthAdapterPolicy $ref: '#/components/schemas/vnic.EthAdapterPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicEthAdapterPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. EthNetworkPolicy: # A Relationship to MO vnic.EthNetworkPolicy $ref: '#/components/schemas/vnic.EthNetworkPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicEthNetworkPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. EthQosPolicy: # A Relationship to MO vnic.EthQosPolicy $ref: '#/components/schemas/vnic.EthQosPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicEthQosPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. FabricEthNetworkControlPolicy: # A Relationship to MO fabric.EthNetworkControlPolicy $ref: '#/components/schemas/fabric.EthNetworkControlPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricEthNetworkControlPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. FabricEthNetworkGroupPolicy: # A Relationship to MO fabric.EthNetworkGroupPolicy description: An array of relationships to fabricEthNetworkGroupPolicy resources. type: array items: $ref: '#/components/schemas/fabric.EthNetworkGroupPolicy.Relationship' nullable: true LanConnectivityPolicy: # A Relationship to MO vnic.LanConnectivityPolicy $ref: '#/components/schemas/vnic.LanConnectivityPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicLanConnectivityPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. LcpVnic: # A Relationship to MO vnic.EthIf $ref: '#/components/schemas/vnic.EthIf.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicEthIf resource. When the $expand query parameter is specified, the referenced resource is returned inline. MacLease: # A Relationship to MO macpool.Lease $ref: '#/components/schemas/macpool.Lease.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolLease resource. When the $expand query parameter is specified, the referenced resource is returned inline. MacPool: # A Relationship to MO macpool.Pool $ref: '#/components/schemas/macpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a macpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. Profile: # A Relationship to MO policy.AbstractConfigProfile $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a policyAbstractConfigProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. SpVnics: # A Relationship to MO vnic.EthIf description: An array of relationships to vnicEthIf resources. type: array items: $ref: '#/components/schemas/vnic.EthIf.Relationship' nullable: true vnic.EthIf.List: title: List of 'vnic.EthIf' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.EthIf' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.EthIf' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.EthIf' nullable: true vnic.EthInterruptSettings: title: Interrupt Settings description: |- Interrupt settings for the virtual ethernet interface. x-allOf-name: vnic.EthInterruptSettings allOf: - # This 'vnic.EthInterruptSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.EthInterruptSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.EthInterruptSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.EthInterruptSettings' ObjectType: enum: - 'vnic.EthInterruptSettings' CoalescingTime: description: |- The time to wait between interrupts or the idle period that must be encountered before an interrupt is sent. To turn off interrupt coalescing, enter 0 (zero) in this field. type: integer format: int64 minimum: 0 maximum: 65535 x-omitempty: true CoalescingType: description: |- Interrupt Coalescing Type. This can be one of the following:- MIN - The system waits for the time specified in the Coalescing Time field before sending another interrupt event IDLE - The system does not send an interrupt until there is a period of no activity lasting as least as long as the time specified in the Coalescing Time field. * `MIN` - The system waits for the time specified in the Coalescing Time field before sending another interrupt event. * `IDLE` - The system does not send an interrupt until there is a period of no activity lasting as least as long as the time specified in the Coalescing Time field. type: string enum: - 'MIN' - 'IDLE' default: MIN x-omitempty: true Count: description: |- The number of interrupt resources to allocate. Typical value is be equal to the number of completion queue resources. type: integer format: int64 minimum: 1 maximum: 514 x-omitempty: true Mode: description: |- Preferred driver interrupt mode. This can be one of the following:- MSIx - Message Signaled Interrupts (MSI) with the optional extension. MSI - MSI only. INTx - PCI INTx interrupts. MSIx is the recommended option. * `MSIx` - Message Signaled Interrupt (MSI) mechanism with the optional extension (MSIx). MSIx is the recommended and default option. * `MSI` - Message Signaled Interrupt (MSI) mechanism that treats messages as interrupts. * `INTx` - Line-based interrupt (INTx) mechanism similar to the one used in Legacy systems. type: string enum: - 'MSIx' - 'MSI' - 'INTx' default: MSIx x-omitempty: true vnic.EthNetworkPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.EthNetworkPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.EthNetworkPolicy' resources. x-one-of-name: vnic.EthNetworkPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.EthNetworkPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.EthNetworkPolicy.Relationship: description: A relationship to the 'vnic.EthNetworkPolicy' resource, or the expanded 'vnic.EthNetworkPolicy' resource, or the 'null' value. x-one-of-name: vnic.EthNetworkPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.EthNetworkPolicy' vnic.EthNetworkPolicy: title: Ethernet Network description: |- An Ethernet Network policy determines if the port can carry single VLAN (Access) or multiple VLANs (Trunk) traffic. You can specify the VLAN to be associated with an Ethernet packet if no tag is found. x-allOf-name: vnic.EthNetworkPolicy allOf: - # This 'vnic.EthNetworkPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.EthNetworkPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.EthNetworkPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.EthNetworkPolicy' ObjectType: enum: - 'vnic.EthNetworkPolicy' TargetPlatform: description: |- The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight. * `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. * `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight. type: string enum: - 'Standalone' - 'FIAttached' default: Standalone x-omitempty: true VlanSettings: description: |- VLAN configuration for the virtual interface. $ref: '#/components/schemas/vnic.VlanSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true vnic.EthNetworkPolicy.List: title: List of 'vnic.EthNetworkPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.EthNetworkPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.EthNetworkPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.EthNetworkPolicy' nullable: true vnic.EthQosPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.EthQosPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.EthQosPolicy' resources. x-one-of-name: vnic.EthQosPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.EthQosPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.EthQosPolicy.Relationship: description: A relationship to the 'vnic.EthQosPolicy' resource, or the expanded 'vnic.EthQosPolicy' resource, or the 'null' value. x-one-of-name: vnic.EthQosPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.EthQosPolicy' vnic.EthQosPolicy: title: Ethernet QoS description: |- An Ethernet Quality of Service (QoS) policy assigns a system class to the outgoing traffic for a vNIC. This system class determines the quality of service for the outgoing traffic. For certain adapters additional controls can be specified like burst and rate on the outgoing traffic. x-allOf-name: vnic.EthQosPolicy allOf: - # This 'vnic.EthQosPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.EthQosPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.EthQosPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.EthQosPolicy' ObjectType: enum: - 'vnic.EthQosPolicy' Cos: description: |- Class of Service to be associated to the traffic on the virtual interface. type: integer format: int64 minimum: 0 maximum: 6 x-omitempty: true Mtu: description: |- The Maximum Transmission Unit (MTU) or packet size that the virtual interface accepts. type: integer format: int64 minimum: 1500 maximum: 9000 x-omitempty: true Priority: description: |- The priortity matching the System QoS specified in the fabric profile. * `Best Effort` - QoS Priority for Best-effort traffic. * `FC` - QoS Priority for FC traffic. * `Platinum` - QoS Priority for Platinum traffic. * `Gold` - QoS Priority for Gold traffic. * `Silver` - QoS Priority for Silver traffic. * `Bronze` - QoS Priority for Bronze traffic. type: string enum: - 'Best Effort' - 'FC' - 'Platinum' - 'Gold' - 'Silver' - 'Bronze' default: Best Effort x-omitempty: true RateLimit: description: |- The value in Mbps (0-10G/40G/100G depending on Adapter Model) to use for limiting the data rate on the virtual interface. Setting this to zero will turn rate limiting off. type: integer format: int64 minimum: 0 maximum: 100000 x-omitempty: true TrustHostCos: description: |- Enables usage of the Class of Service provided by the operating system. type: boolean x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true vnic.EthQosPolicy.List: title: List of 'vnic.EthQosPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.EthQosPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.EthQosPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.EthQosPolicy' nullable: true vnic.EthRxQueueSettings: title: Queue Settings description: |- Receive Queue resource settings. x-allOf-name: vnic.EthRxQueueSettings allOf: - # This 'vnic.EthRxQueueSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.EthRxQueueSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.EthRxQueueSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.EthRxQueueSettings' ObjectType: enum: - 'vnic.EthRxQueueSettings' Count: description: |- The number of queue resources to allocate. type: integer format: int64 minimum: 1 maximum: 256 x-omitempty: true RingSize: description: |- The number of descriptors in each queue. type: integer format: int64 minimum: 64 maximum: 4096 x-omitempty: true vnic.EthTxQueueSettings: title: Queue Settings description: |- Transmit Queue resource settings. x-allOf-name: vnic.EthTxQueueSettings allOf: - # This 'vnic.EthTxQueueSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.EthTxQueueSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.EthTxQueueSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.EthTxQueueSettings' ObjectType: enum: - 'vnic.EthTxQueueSettings' Count: description: |- The number of queue resources to allocate. type: integer format: int64 minimum: 1 maximum: 256 x-omitempty: true RingSize: description: |- The number of descriptors in each queue. type: integer format: int64 minimum: 64 maximum: 4096 x-omitempty: true vnic.FcAdapterPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.FcAdapterPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.FcAdapterPolicy' resources. x-one-of-name: vnic.FcAdapterPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.FcAdapterPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.FcAdapterPolicy.Relationship: description: A relationship to the 'vnic.FcAdapterPolicy' resource, or the expanded 'vnic.FcAdapterPolicy' resource, or the 'null' value. x-one-of-name: vnic.FcAdapterPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.FcAdapterPolicy' vnic.FcAdapterPolicy: title: Fibre Channel Adapter description: |- A Fibre Channel Adapter policy governs the host-side behavior of the adapter, including how the adapter handles traffic. You can enable FCP Error Recovery, change the default settings of Queues and Interrupt handling for performance enhancement. x-allOf-name: vnic.FcAdapterPolicy allOf: - # This 'vnic.FcAdapterPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.FcAdapterPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FcAdapterPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FcAdapterPolicy' ObjectType: enum: - 'vnic.FcAdapterPolicy' ErrorDetectionTimeout: description: |- Error Detection Timeout, also referred to as EDTOV, is the number of milliseconds to wait before the system assumes that an error has occurred. type: integer format: int64 minimum: 1000 maximum: 100000 x-omitempty: true ErrorRecoverySettings: description: |- Fibre Channel Error Recovery Settings. $ref: '#/components/schemas/vnic.FcErrorRecoverySettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true FlogiSettings: description: |- Fibre Channel Flogi Settings. $ref: '#/components/schemas/vnic.FlogiSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true InterruptSettings: description: |- Interrupt Settings for the virtual fibre channel interface. $ref: '#/components/schemas/vnic.FcInterruptSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IoThrottleCount: description: |- The maximum number of data or control I/O operations that can be pending for the virtual interface at one time. If this value is exceeded, the additional I/O operations wait in the queue until the number of pending I/O operations decreases and the additional operations can be processed. type: integer format: int64 minimum: 1 maximum: 1024 x-omitempty: true LunCount: description: |- The maximum number of LUNs that the Fibre Channel driver will export or show. The maximum number of LUNs is usually controlled by the operating system running on the server. type: integer format: int64 minimum: 1 maximum: 1024 x-omitempty: true LunQueueDepth: description: |- The number of commands that the HBA can send and receive in a single transmission per LUN. type: integer format: int64 minimum: 1 maximum: 254 x-omitempty: true PlogiSettings: description: |- Fibre Channel Plogi Settings. $ref: '#/components/schemas/vnic.PlogiSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ResourceAllocationTimeout: description: |- Resource Allocation Timeout, also referred to as RATOV, is the number of milliseconds to wait before the system assumes that a resource cannot be properly allocated. type: integer format: int64 minimum: 5000 maximum: 100000 x-omitempty: true RxQueueSettings: description: |- Fibre Channel Receive Queue Settings. $ref: '#/components/schemas/vnic.FcQueueSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ScsiQueueSettings: description: |- SCSI Input/Output Queue Settings. $ref: '#/components/schemas/vnic.ScsiQueueSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true TxQueueSettings: description: |- Fibre Channel Transmit Queue Settings. $ref: '#/components/schemas/vnic.FcQueueSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true vnic.FcAdapterPolicy.List: title: List of 'vnic.FcAdapterPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.FcAdapterPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.FcAdapterPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.FcAdapterPolicy' nullable: true vnic.FcErrorRecoverySettings: title: Error Recovery Settings description: |- Fibre Channel Error Recovery Settings. x-allOf-name: vnic.FcErrorRecoverySettings allOf: - # This 'vnic.FcErrorRecoverySettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.FcErrorRecoverySettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FcErrorRecoverySettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FcErrorRecoverySettings' ObjectType: enum: - 'vnic.FcErrorRecoverySettings' Enabled: description: |- Enables Fibre Channel Error recovery. type: boolean x-omitempty: true IoRetryCount: description: |- The number of times an I/O request to a port is retried because the port is busy before the system decides the port is unavailable. type: integer format: int64 minimum: 0 maximum: 255 x-omitempty: true IoRetryTimeout: description: |- The number of seconds the adapter waits before aborting the pending command and resending the same IO request. type: integer format: int64 minimum: 1 maximum: 59 x-omitempty: true LinkDownTimeout: description: |- The number of milliseconds the port should actually be down before it is marked down and fabric connectivity is lost. type: integer format: int64 minimum: 0 maximum: 240000 x-omitempty: true PortDownTimeout: description: |- The number of milliseconds a remote Fibre Channel port should be offline before informing the SCSI upper layer that the port is unavailable. For a server with a VIC adapter running ESXi, the recommended value is 10000. For a server with a port used to boot a Windows OS from the SAN, the recommended value is 5000 milliseconds. type: integer format: int64 minimum: 0 maximum: 240000 x-omitempty: true vnic.FcIf.Response: description: |- The response body of a HTTP GET request for the 'vnic.FcIf' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.FcIf' resources. x-one-of-name: vnic.FcIf.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.FcIf.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.FcIf.Relationship: description: A relationship to the 'vnic.FcIf' resource, or the expanded 'vnic.FcIf' resource, or the 'null' value. x-one-of-name: vnic.FcIf.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.FcIf' vnic.FcIf: title: Virtual Fibre Channel Interface description: |- Virtual Fibre Channel Interface. x-allOf-name: vnic.FcIf allOf: - # This 'vnic.FcIf' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'vnic.FcIf' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FcIf', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FcIf' ObjectType: enum: - 'vnic.FcIf' Name: description: |- Name of the virtual fibre channel interface. type: string pattern: "^[a-zA-Z0-9\\-\\._:]*$" maxLength: 31 x-omitempty: true Order: description: |- The order in which the virtual interface is brought up. The order assigned to an interface should be unique for all the Ethernet and Fibre-Channel interfaces on each PCI link on a VIC adapter. The maximum value of PCI order is limited by the number of virtual interfaces (Ethernet and Fibre-Channel) on each PCI link on a VIC adapter. All VIC adapters have a single PCI link except VIC 1385 which has two. type: integer format: int64 x-omitempty: true PersistentBindings: description: |- Enables retention of LUN ID associations in memory until they are manually cleared. type: boolean x-omitempty: true Placement: description: |- Placement Settings for the virtual interface. $ref: '#/components/schemas/vnic.PlacementSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Type: description: |- VHBA Type configuration for SAN Connectivity Policy. This configuration is supported only on Cisco VIC 14XX series and higher series of adapters. * `fc-initiator` - The default value set for vHBA Type Configuration. Fc-initiator specifies vHBA as a consumer of storage. Enables SCSI commands to transfer data and status information between host and target storage systems. * `fc-nvme-initiator` - Fc-nvme-initiator specifies vHBA as a consumer of storage. Enables NVMe-based message commands to transfer data and status information between host and target storage systems. * `fc-nvme-target` - Fc-nvme-target specifies vHBA as a provider of storage volumes to initiators. Enables NVMe-based message commands to transfer data and status information between host and target storage systems. Currently tech-preview, only enabled with an asynchronous driver. * `fc-target` - Fc-target specifies vHBA as a provider of storage volumes to initiators. Enables SCSI commands to transfer data and status information between host and target storage systems. fc-target is enabled only with an asynchronous driver. type: string enum: - 'fc-initiator' - 'fc-nvme-initiator' - 'fc-nvme-target' - 'fc-target' default: fc-initiator x-omitempty: true VifId: description: |- This should be the same as the channel number of the vfc created on switch in order to set up the data path. The property is applicable only for FI attached servers where a vfc is created on the switch for every vHBA. type: integer format: int64 readOnly: true x-omitempty: true Wwpn: description: |- The WWPN address that is assigned to the vhba based on the wwn pool that has been assigned to the SAN Connectivity Policy. type: string pattern: "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2}))" readOnly: true x-omitempty: true FcAdapterPolicy: # A Relationship to MO vnic.FcAdapterPolicy $ref: '#/components/schemas/vnic.FcAdapterPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicFcAdapterPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. FcNetworkPolicy: # A Relationship to MO vnic.FcNetworkPolicy $ref: '#/components/schemas/vnic.FcNetworkPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicFcNetworkPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. FcQosPolicy: # A Relationship to MO vnic.FcQosPolicy $ref: '#/components/schemas/vnic.FcQosPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicFcQosPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. Profile: # A Relationship to MO policy.AbstractConfigProfile $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a policyAbstractConfigProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. SanConnectivityPolicy: # A Relationship to MO vnic.SanConnectivityPolicy $ref: '#/components/schemas/vnic.SanConnectivityPolicy.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicSanConnectivityPolicy resource. When the $expand query parameter is specified, the referenced resource is returned inline. ScpVhba: # A Relationship to MO vnic.FcIf $ref: '#/components/schemas/vnic.FcIf.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a vnicFcIf resource. When the $expand query parameter is specified, the referenced resource is returned inline. SpVhbas: # A Relationship to MO vnic.FcIf description: An array of relationships to vnicFcIf resources. type: array items: $ref: '#/components/schemas/vnic.FcIf.Relationship' nullable: true WwpnLease: # A Relationship to MO fcpool.Lease $ref: '#/components/schemas/fcpool.Lease.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolLease resource. When the $expand query parameter is specified, the referenced resource is returned inline. WwpnPool: # A Relationship to MO fcpool.Pool $ref: '#/components/schemas/fcpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. vnic.FcIf.List: title: List of 'vnic.FcIf' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.FcIf' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.FcIf' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.FcIf' nullable: true vnic.FcInterruptSettings: title: Interrupt Settings description: |- Interrupt Settings for the virtual fibre channel interface. x-allOf-name: vnic.FcInterruptSettings allOf: - # This 'vnic.FcInterruptSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.FcInterruptSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FcInterruptSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FcInterruptSettings' ObjectType: enum: - 'vnic.FcInterruptSettings' Mode: description: |- The preferred driver interrupt mode. This can be one of the following:- MSIx - Message Signaled Interrupts (MSI) with the optional extension. MSI - MSI only. INTx - PCI INTx interrupts. MSIx is the recommended option. * `MSIx` - Message Signaled Interrupt (MSI) mechanism with the optional extension (MSIx). MSIx is the recommended and default option. * `MSI` - Message Signaled Interrupt (MSI) mechanism that treats messages as interrupts. * `INTx` - Line-based interrupt (INTx) mechanism similar to the one used in Legacy systems. type: string enum: - 'MSIx' - 'MSI' - 'INTx' default: MSIx x-omitempty: true vnic.FcNetworkPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.FcNetworkPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.FcNetworkPolicy' resources. x-one-of-name: vnic.FcNetworkPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.FcNetworkPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.FcNetworkPolicy.Relationship: description: A relationship to the 'vnic.FcNetworkPolicy' resource, or the expanded 'vnic.FcNetworkPolicy' resource, or the 'null' value. x-one-of-name: vnic.FcNetworkPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.FcNetworkPolicy' vnic.FcNetworkPolicy: title: Fibre Channel Network description: |- A Fibre Channel Network policy governs the VSAN configuration for the virtual interfaces. x-allOf-name: vnic.FcNetworkPolicy allOf: - # This 'vnic.FcNetworkPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.FcNetworkPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FcNetworkPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FcNetworkPolicy' ObjectType: enum: - 'vnic.FcNetworkPolicy' VsanSettings: description: |- VSAN configuration for the virtual interface. $ref: '#/components/schemas/vnic.VsanSettings' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true vnic.FcNetworkPolicy.List: title: List of 'vnic.FcNetworkPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.FcNetworkPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.FcNetworkPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.FcNetworkPolicy' nullable: true vnic.FcQosPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.FcQosPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.FcQosPolicy' resources. x-one-of-name: vnic.FcQosPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.FcQosPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.FcQosPolicy.Relationship: description: A relationship to the 'vnic.FcQosPolicy' resource, or the expanded 'vnic.FcQosPolicy' resource, or the 'null' value. x-one-of-name: vnic.FcQosPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.FcQosPolicy' vnic.FcQosPolicy: title: Fibre Channel QoS description: |- A Fibre Channel Quality of Service (QoS) policy assigns a system class to the outgoing traffic for a vHBA. This system class determines the quality of service for the outgoing traffic. For certain adapters additional controls can also be specified like burst and rate on the outgoing traffic. x-allOf-name: vnic.FcQosPolicy allOf: - # This 'vnic.FcQosPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.FcQosPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FcQosPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FcQosPolicy' ObjectType: enum: - 'vnic.FcQosPolicy' Cos: description: |- Class of Service to be associated to the traffic on the virtual interface. type: integer format: int64 minimum: 0 maximum: 6 x-omitempty: true MaxDataFieldSize: description: |- The maximum size of the Fibre Channel frame payload bytes that the virtual interface supports. type: integer format: int64 minimum: 256 maximum: 2112 x-omitempty: true Priority: description: |- The priortity matching the System QoS specified in the fabric profile. * `Best Effort` - QoS Priority for Best-effort traffic. * `FC` - QoS Priority for FC traffic. * `Platinum` - QoS Priority for Platinum traffic. * `Gold` - QoS Priority for Gold traffic. * `Silver` - QoS Priority for Silver traffic. * `Bronze` - QoS Priority for Bronze traffic. type: string enum: - 'Best Effort' - 'FC' - 'Platinum' - 'Gold' - 'Silver' - 'Bronze' default: Best Effort readOnly: true x-omitempty: true RateLimit: description: |- The value in Mbps to use for limiting the data rate on the virtual interface. Setting this to zero will turn rate limiting off. type: integer format: int64 minimum: 0 maximum: 100000 x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true vnic.FcQosPolicy.List: title: List of 'vnic.FcQosPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.FcQosPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.FcQosPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.FcQosPolicy' nullable: true vnic.FcQueueSettings: title: Queue Settings description: |- Transmit/Receive Queue resource settings. x-allOf-name: vnic.FcQueueSettings allOf: - # This 'vnic.FcQueueSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.FcQueueSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FcQueueSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FcQueueSettings' ObjectType: enum: - 'vnic.FcQueueSettings' Count: description: |- The number of queue resources to allocate. type: integer format: int64 minimum: 1 maximum: 1 readOnly: true x-omitempty: true RingSize: description: |- The number of descriptors in each queue. type: integer format: int64 minimum: 64 maximum: 128 x-omitempty: true vnic.FlogiSettings: title: Flogi Settings description: |- Fibre Channel Flogi Settings. x-allOf-name: vnic.FlogiSettings allOf: - # This 'vnic.FlogiSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.FlogiSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.FlogiSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.FlogiSettings' ObjectType: enum: - 'vnic.FlogiSettings' Retries: description: |- The number of times that the system tries to log in to the fabric after the first failure. type: integer format: int64 minimum: 0 x-omitempty: true Timeout: description: |- The number of milliseconds that the system waits before it tries to log in again. type: integer format: int64 minimum: 1000 maximum: 255000 x-omitempty: true vnic.LanConnectivityPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.LanConnectivityPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.LanConnectivityPolicy' resources. x-one-of-name: vnic.LanConnectivityPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.LanConnectivityPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.LanConnectivityPolicy.Relationship: description: A relationship to the 'vnic.LanConnectivityPolicy' resource, or the expanded 'vnic.LanConnectivityPolicy' resource, or the 'null' value. x-one-of-name: vnic.LanConnectivityPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.LanConnectivityPolicy' vnic.LanConnectivityPolicy: title: LAN Connectivity description: |- A LAN Connectivity Policy determines the network resources and the connections between the server and the LAN on the network. This policy uses Consistent Device Naming to configure the vNIC. You can configure a usNIC or VMQ connection for the vNIC to improve network performance. x-allOf-name: vnic.LanConnectivityPolicy allOf: - # This 'vnic.LanConnectivityPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.LanConnectivityPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.LanConnectivityPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.LanConnectivityPolicy' ObjectType: enum: - 'vnic.LanConnectivityPolicy' PlacementMode: description: |- The mode used for placement of vnics on network adapters. It can either be Auto or Custom. * `custom` - The placement of the vNICs / vHBAs on network adapters is manually chosen by the user. * `auto` - The placement of the vNICs / vHBAs on network adapters is automatically determined by the system. type: string enum: - 'custom' - 'auto' default: custom x-omitempty: true TargetPlatform: description: |- The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight. * `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. * `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight. deprecated: true type: string enum: - 'Standalone' - 'FIAttached' default: Standalone x-omitempty: true EthIfs: # A Relationship to MO vnic.EthIf description: An array of relationships to vnicEthIf resources. type: array items: $ref: '#/components/schemas/vnic.EthIf.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true vnic.LanConnectivityPolicy.List: title: List of 'vnic.LanConnectivityPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.LanConnectivityPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.LanConnectivityPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.LanConnectivityPolicy' nullable: true vnic.LcpStatus.Response: description: |- The response body of a HTTP GET request for the 'vnic.LcpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.LcpStatus' resources. x-one-of-name: vnic.LcpStatus.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.LcpStatus.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.LcpStatus: title: LCP Status description: |- An internal MO to check if a LCP can be deployed or not on a specific Server Profile. x-allOf-name: vnic.LcpStatus allOf: - # This 'vnic.LcpStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'vnic.LcpStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.LcpStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.LcpStatus' ObjectType: enum: - 'vnic.LcpStatus' Reason: description: |- The reason for the status - it will be empty if status is ok or validating. If error, it will have the appropriate message indicating the reason for failure. type: string x-omitempty: true Status: description: |- Indicates if the LCP is ready for Deploy or not. * `ok` - No issues with the LCP/SCP/VIF. * `error` - The LCP/SCP/VIF cannot be deployed due to error. * `validating` - Validation in progress for the LCP. type: string enum: - 'ok' - 'error' - 'validating' default: ok x-omitempty: true VnicInfo: type: array items: description: |- The status of all the vNICs in the LCP. $ref: '#/components/schemas/vnic.VifStatus' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Profile: # A Relationship to MO policy.AbstractConfigProfile $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a policyAbstractConfigProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. vnic.LcpStatus.List: title: List of 'vnic.LcpStatus' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.LcpStatus' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.LcpStatus' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.LcpStatus' nullable: true vnic.NvgreSettings: title: NVGRE Settings description: |- Network Virtualization using Generic Routing Encapsulation Settings. x-allOf-name: vnic.NvgreSettings allOf: - # This 'vnic.NvgreSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.NvgreSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.NvgreSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.NvgreSettings' ObjectType: enum: - 'vnic.NvgreSettings' Enabled: description: |- Status of the Network Virtualization using Generic Routing Encapsulation on the virtual ethernet interface. type: boolean x-omitempty: true vnic.PlacementSettings: title: Placement Settings description: |- Placement Settings for the virtual interface. x-allOf-name: vnic.PlacementSettings allOf: - # This 'vnic.PlacementSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.PlacementSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.PlacementSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.PlacementSettings' ObjectType: enum: - 'vnic.PlacementSettings' Id: description: |- PCIe Slot where the VIC adapter is installed. Supported values are (1-15) and MLOM. type: string pattern: "^$|^([1-9]|1[0-5]|MLOM)$" x-omitempty: true PciLink: description: |- The PCI Link used as transport for the virtual interface. All VIC adapters have a single PCI link except VIC 1385 which has two. type: integer format: int64 minimum: 0 maximum: 1 x-omitempty: true SwitchId: description: |- The fabric port to which the vnics will be associated. * `None` - Fabric Id is not set to either A or B for the standalone case where the server is not connected to Fabric Interconnects. The value 'None' should be used. * `A` - Fabric A of the FI cluster. * `B` - Fabric B of the FI cluster. type: string enum: - 'None' - 'A' - 'B' default: None x-omitempty: true Uplink: description: |- Adapter port on which the virtual interface will be created. type: integer format: int64 minimum: 0 maximum: 3 x-omitempty: true vnic.PlogiSettings: title: Plogi Settings description: |- Fibre Channel Plogi Settings. x-allOf-name: vnic.PlogiSettings allOf: - # This 'vnic.PlogiSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.PlogiSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.PlogiSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.PlogiSettings' ObjectType: enum: - 'vnic.PlogiSettings' Retries: description: |- The number of times that the system tries to log in to a port after the first failure. type: integer format: int64 minimum: 0 maximum: 255 x-omitempty: true Timeout: description: |- The number of milliseconds that the system waits before it tries to log in again. type: integer format: int64 minimum: 1000 maximum: 255000 x-omitempty: true vnic.RoceSettings: title: RoCE Settings description: |- Settings for RDMA over Converged Ethernet. x-allOf-name: vnic.RoceSettings allOf: - # This 'vnic.RoceSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.RoceSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.RoceSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.RoceSettings' ObjectType: enum: - 'vnic.RoceSettings' ClassOfService: description: |- The Class of Service for RoCE on this virtual interface. * `5` - RDMA CoS Service Level 5. * `1` - RDMA CoS Service Level 1. * `2` - RDMA CoS Service Level 2. * `4` - RDMA CoS Service Level 4. * `6` - RDMA CoS Service Level 6. type: integer enum: - 5 - 1 - 2 - 4 - 6 default: 5 x-omitempty: true Enabled: description: |- If enabled sets RDMA over Converged Ethernet (RoCE) on this virtual interface. type: boolean x-omitempty: true MemoryRegions: description: |- The number of memory regions per adapter. Recommended value = integer power of 2. type: integer format: int64 minimum: 0 maximum: 524288 x-omitempty: true QueuePairs: description: |- The number of queue pairs per adapter. Recommended value = integer power of 2. type: integer format: int64 minimum: 0 maximum: 8192 x-omitempty: true ResourceGroups: description: |- The number of resource groups per adapter. Recommended value = be an integer power of 2 greater than or equal to the number of CPU cores on the system for optimum performance. type: integer format: int64 minimum: 0 maximum: 128 x-omitempty: true Version: description: |- Configures RDMA over Converged Ethernet (RoCE) version on the virtual interface. Only RoceV1 is supported onn Cisco VIC models 13xx and only RoceV2 is supported on models 14xx. * `1` - RDMA over Converged Ethernet Protocol Version 1. * `2` - RDMA over Converged Ethernet Protocol Version 2. type: integer enum: - 1 - 2 default: 1 x-omitempty: true vnic.RssHashSettings: title: RSS Hash Profile description: |- The RSS Hash parameters help the traffic distribution across the Receive Queues based on the IP address (IPv4 or IPv6) and TCP Port numbers. These options help ensure that a single flow is directed to the same receive queue ensuring in-order delivery. x-allOf-name: vnic.RssHashSettings allOf: - # This 'vnic.RssHashSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.RssHashSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.RssHashSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.RssHashSettings' ObjectType: enum: - 'vnic.RssHashSettings' Ipv4Hash: description: |- When enabled, the IPv4 address is used for traffic distribution. type: boolean x-omitempty: true Ipv6ExtHash: description: |- When enabled, the IPv6 extensions are used for traffic distribution. type: boolean x-omitempty: true Ipv6Hash: description: |- When enabled, the IPv6 address is used for traffic distribution. type: boolean x-omitempty: true TcpIpv4Hash: description: |- When enabled, both the IPv4 address and TCP port number are used for traffic distribution. type: boolean x-omitempty: true TcpIpv6ExtHash: description: |- When enabled, both the IPv6 extensions and TCP port number are used for traffic distribution. type: boolean x-omitempty: true TcpIpv6Hash: description: |- When enabled, both the IPv6 address and TCP port number are used for traffic distribution. type: boolean x-omitempty: true UdpIpv4Hash: description: |- When enabled, both the IPv4 address and UDP port number are used for traffic distribution. type: boolean x-omitempty: true UdpIpv6Hash: description: |- When enabled, both the IPv6 address and UDP port number are used for traffic distribution. type: boolean x-omitempty: true vnic.SanConnectivityPolicy.Response: description: |- The response body of a HTTP GET request for the 'vnic.SanConnectivityPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.SanConnectivityPolicy' resources. x-one-of-name: vnic.SanConnectivityPolicy.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.SanConnectivityPolicy.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.SanConnectivityPolicy.Relationship: description: A relationship to the 'vnic.SanConnectivityPolicy' resource, or the expanded 'vnic.SanConnectivityPolicy' resource, or the 'null' value. x-one-of-name: vnic.SanConnectivityPolicy.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vnic.SanConnectivityPolicy' vnic.SanConnectivityPolicy: title: SAN Connectivity description: |- SAN connectivity policy determines the network storage resources and the connections between the server and the SAN on the network. This policy enables configuration of vHBAs that the servers use to communicate with the storage network. x-allOf-name: vnic.SanConnectivityPolicy allOf: - # This 'vnic.SanConnectivityPolicy' class inherits all properties from its parent class policy.AbstractPolicy. $ref: '#/components/schemas/policy.AbstractPolicy' - # The definition of all the properties specified in this 'vnic.SanConnectivityPolicy' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.SanConnectivityPolicy', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.SanConnectivityPolicy' ObjectType: enum: - 'vnic.SanConnectivityPolicy' PlacementMode: description: |- The mode used for placement of vnics on network adapters. It can either be Auto or Custom. * `custom` - The placement of the vNICs / vHBAs on network adapters is manually chosen by the user. * `auto` - The placement of the vNICs / vHBAs on network adapters is automatically determined by the system. type: string enum: - 'custom' - 'auto' default: custom x-omitempty: true TargetPlatform: description: |- The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight. * `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. * `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight. type: string enum: - 'Standalone' - 'FIAttached' default: Standalone x-omitempty: true FcIfs: # A Relationship to MO vnic.FcIf description: An array of relationships to vnicFcIf resources. type: array items: $ref: '#/components/schemas/vnic.FcIf.Relationship' nullable: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Profiles: # A Relationship to MO policy.AbstractConfigProfile description: An array of relationships to policyAbstractConfigProfile resources. type: array items: $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' nullable: true WwnnPool: # A Relationship to MO fcpool.Pool $ref: '#/components/schemas/fcpool.Pool.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fcpoolPool resource. When the $expand query parameter is specified, the referenced resource is returned inline. vnic.SanConnectivityPolicy.List: title: List of 'vnic.SanConnectivityPolicy' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.SanConnectivityPolicy' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.SanConnectivityPolicy' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.SanConnectivityPolicy' nullable: true vnic.ScpStatus.Response: description: |- The response body of a HTTP GET request for the 'vnic.ScpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vnic.ScpStatus' resources. x-one-of-name: vnic.ScpStatus.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vnic.ScpStatus.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vnic.ScpStatus: title: SCP Status description: |- An internal MO to check if a SCP can be deployed or not on a specific Server Profile. x-allOf-name: vnic.ScpStatus allOf: - # This 'vnic.ScpStatus' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'vnic.ScpStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.ScpStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.ScpStatus' ObjectType: enum: - 'vnic.ScpStatus' Reason: description: |- The reason for the status - it will be empty if status is ok or validating. If error, it will have the appropriate message indicating the reason for failure. type: string x-omitempty: true Status: description: |- Indicates if the LCP is ready for Deploy or not. * `ok` - No issues with the LCP/SCP/VIF. * `error` - The LCP/SCP/VIF cannot be deployed due to error. * `validating` - Validation in progress for the LCP. type: string enum: - 'ok' - 'error' - 'validating' default: ok x-omitempty: true VhbaInfo: type: array items: description: |- The status of all the vHBAs in the LCP. $ref: '#/components/schemas/vnic.VifStatus' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Profile: # A Relationship to MO policy.AbstractConfigProfile $ref: '#/components/schemas/policy.AbstractConfigProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a policyAbstractConfigProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. vnic.ScpStatus.List: title: List of 'vnic.ScpStatus' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vnic.ScpStatus' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vnic.ScpStatus' resources matching the request. type: array items: $ref: '#/components/schemas/vnic.ScpStatus' nullable: true vnic.ScsiQueueSettings: title: SCSI Queue Settings description: |- SCSI Queue resource settings. x-allOf-name: vnic.ScsiQueueSettings allOf: - # This 'vnic.ScsiQueueSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.ScsiQueueSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.ScsiQueueSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.ScsiQueueSettings' ObjectType: enum: - 'vnic.ScsiQueueSettings' Count: description: |- The number of SCSI I/O queue resources the system should allocate. type: integer format: int64 minimum: 1 maximum: 64 x-omitempty: true RingSize: description: |- The number of descriptors in each SCSI I/O queue. type: integer format: int64 minimum: 64 maximum: 512 x-omitempty: true vnic.TcpOffloadSettings: title: TCP Offload description: |- The TCP offload settings decide whether to offload the TCP related network functions from the CPU to the network hardware or not. These options help reduce the CPU overhead and increase the network throughput. x-allOf-name: vnic.TcpOffloadSettings allOf: - # This 'vnic.TcpOffloadSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.TcpOffloadSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.TcpOffloadSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.TcpOffloadSettings' ObjectType: enum: - 'vnic.TcpOffloadSettings' LargeReceive: description: |- Enables the reassembly of segmented packets in hardware before sending them to the CPU. type: boolean x-omitempty: true LargeSend: description: |- Enables the CPU to send large packets to the hardware for segmentation. type: boolean x-omitempty: true RxChecksum: description: |- When enabled, the CPU sends all packet checksums to the hardware for validation. type: boolean x-omitempty: true TxChecksum: description: |- When enabled, the CPU sends all packets to the hardware so that the checksum can be calculated. type: boolean x-omitempty: true vnic.UsnicSettings: title: USNIC Settings description: |- User Space NIC Settings that enable low-latency and higher throughput by bypassing the kernel layer when sending/receiving packets. x-allOf-name: vnic.UsnicSettings allOf: - # This 'vnic.UsnicSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.UsnicSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.UsnicSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.UsnicSettings' ObjectType: enum: - 'vnic.UsnicSettings' Cos: description: |- Class of Service to be used for traffic on the usNIC. type: integer format: int64 minimum: 0 maximum: 6 x-omitempty: true Count: description: |- Number of usNIC interfaces to be created. type: integer format: int64 minimum: 0 maximum: 225 x-omitempty: true UsnicAdapterPolicy: description: |- Ethernet Adapter policy to be associated with the usNICs. type: string x-omitempty: true vnic.VifStatus: title: vNIC / vHBA Status description: |- The status of a vNIC or vHBA. x-allOf-name: vnic.VifStatus allOf: - # This 'vnic.VifStatus' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.VifStatus' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.VifStatus', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.VifStatus' ObjectType: enum: - 'vnic.VifStatus' Name: description: |- Name of the vNIC for which the status is reported. type: string x-omitempty: true Reason: description: |- The reason for the status - it will be empty if status is ok or validating. If error, it will have the appropriate message indicating the reason for failure. type: string x-omitempty: true Status: description: |- Indicates if the vNIC / vHBA is ready for deploy or not. * `ok` - No issues with the LCP/SCP/VIF. * `error` - The LCP/SCP/VIF cannot be deployed due to error. * `validating` - Validation in progress for the LCP. type: string enum: - 'ok' - 'error' - 'validating' default: ok x-omitempty: true vnic.VlanSettings: title: VLAN Settings description: |- VLAN configuration for the virtual interface. x-allOf-name: vnic.VlanSettings allOf: - # This 'vnic.VlanSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.VlanSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.VlanSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.VlanSettings' ObjectType: enum: - 'vnic.VlanSettings' AllowedVlans: description: |- Allowed VLAN IDs of the virtual interface. type: string pattern: "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$" x-omitempty: true DefaultVlan: description: |- Native VLAN ID of the virtual interface or the corresponding vethernet on the peer Fabric Interconnect to which the virtual interface is connected. Setting the ID to 0 will not associate any native VLAN to the traffic on the virtual interface. type: integer format: int64 minimum: 0 maximum: 4094 x-omitempty: true Mode: description: |- Option to determine if the port can carry single VLAN (Access) or multiple VLANs (Trunk) traffic. * `ACCESS` - An access port carries traffic only for a single VLAN on the interface. * `TRUNK` - A trunk port can have two or more VLANs configured on the interface. It can carry traffic for several VLANs simultaneously. type: string enum: - 'ACCESS' - 'TRUNK' default: ACCESS x-omitempty: true vnic.VmqSettings: title: VMQ Settings description: |- Virtual Machine Queue Settings for the virtual interface that allow efficient transfer of network traffic to the guest OS. x-allOf-name: vnic.VmqSettings allOf: - # This 'vnic.VmqSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.VmqSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.VmqSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.VmqSettings' ObjectType: enum: - 'vnic.VmqSettings' Enabled: description: |- Enables VMQ feature on the virtual interface. type: boolean x-omitempty: true MultiQueueSupport: description: |- Enables Virtual Machine Multi-Queue feature on the virtual interface. VMMQ allows configuration of multiple I/O queues for a single VM and, thus, distributes traffic across multiple CPU cores in a VM. type: boolean x-omitempty: true NumInterrupts: description: |- The number of interrupt resources to be allocated. Recommended value is the number of CPU threads or logical processors available in the server. type: integer format: int64 minimum: 1 maximum: 514 x-omitempty: true NumSubVnics: description: |- The number of sub vnics to be created. type: integer format: int64 minimum: 0 maximum: 64 x-omitempty: true NumVmqs: description: |- The number of hardware Virtual Machine Queues to be allocated. The number of VMQs per adapter must be one more than the maximum number of VM NICs. type: integer format: int64 minimum: 1 maximum: 128 x-omitempty: true VmmqAdapterPolicy: description: |- Ethernet Adapter policy to be associated with the subVnics. The Transmit Queue and Receive Queue resource value of VMMQ adapter policy should be greater than or equal to the configured number of sub vnics. type: string x-omitempty: true vnic.VsanSettings: title: VSAN Settings description: |- VSAN configuration for the virtual interface. x-allOf-name: vnic.VsanSettings allOf: - # This 'vnic.VsanSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.VsanSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.VsanSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.VsanSettings' ObjectType: enum: - 'vnic.VsanSettings' Id: description: |- Default VSAN ID of the virtual interface. Setting the ID to 0 will not associate any default VSAN to the traffic on the virtual interface. type: integer format: int64 minimum: 0 maximum: 4094 x-omitempty: true vnic.VxlanSettings: title: Vxlan Settings description: |- Virtual Extensible LAN Protocol Settings. x-allOf-name: vnic.VxlanSettings allOf: - # This 'vnic.VxlanSettings' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'vnic.VxlanSettings' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vnic.VxlanSettings', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vnic.VxlanSettings' ObjectType: enum: - 'vnic.VxlanSettings' Enabled: description: |- Status of the Virtual Extensible LAN Protocol on the virtual ethernet interface. type: boolean x-omitempty: true vrf.Vrf.Response: description: |- The response body of a HTTP GET request for the 'vrf.Vrf' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'vrf.Vrf' resources. x-one-of-name: vrf.Vrf.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/vrf.Vrf.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType vrf.Vrf.Relationship: description: A relationship to the 'vrf.Vrf' resource, or the expanded 'vrf.Vrf' resource, or the 'null' value. x-one-of-name: vrf.Vrf.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/vrf.Vrf' vrf.Vrf: title: Vrf:Vrf description: |- Virtual Routing and Forwarding (VRF) is a networking technology that implements an isolated Layer 3 domain. x-allOf-name: vrf.Vrf allOf: - # This 'vrf.Vrf' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'vrf.Vrf' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'vrf.Vrf', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'vrf.Vrf' ObjectType: enum: - 'vrf.Vrf' Description: description: |- Description to help identify or describe this VRF. type: string x-omitempty: true Name: description: |- Name of the Virtual Routing and Forwarding Instance. type: string x-omitempty: true Account: # A Relationship to MO iam.Account $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true vrf.Vrf.List: title: List of 'vrf.Vrf' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'vrf.Vrf' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'vrf.Vrf' resources matching the request. type: array items: $ref: '#/components/schemas/vrf.Vrf' nullable: true workflow.AbstractWorkerTask: title: Workflow:Abstract Worker Task description: |- An AbstractWorkerTask is used to model a task that does some end-user work. This can be another task or it can be another workflow. x-allOf-name: workflow.AbstractWorkerTask allOf: - # This 'workflow.AbstractWorkerTask' class inherits all properties from its parent class workflow.WorkflowTask. $ref: '#/components/schemas/workflow.WorkflowTask' - # The definition of all the properties specified in this 'workflow.AbstractWorkerTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.AbstractWorkerTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: InputParameters: description: |- JSON formatted map that defines the input given to the task. JSONPath is used for chaining output from previous tasks as inputs into the current task. The format to specify the mapping is '${Source.input/output.JsonPath}'. 'Source' can be either workflow or the name of the task within the workflow. You can map the task input to either a workflow input or a task output. Following this is JSON path expression to extract JSON fragment from source's input/output. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true OnFailure: description: |- This specifies the name of the next task to run if Task fails. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node. type: string x-omitempty: true OnSuccess: description: |- This specifies the name of the next task to run if Task succeeds. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node. type: string x-omitempty: true workflow.Api: title: API description: |- Intersight Orchestrator supports generic API workflow tasks that can execute an API given the request body and response parser specification. API type models a single API request within a batch of requests that get executed within a single workflow task. x-allOf-name: workflow.Api allOf: - # This 'workflow.Api' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.Api' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.Api', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Body: description: |- The optional request body that is sent as part of this API request. The request body can contain a golang template that can be populated with task input parameters and previous API output parameters. type: string x-omitempty: true ContentType: description: |- Intersight Orchestrator, with the support of response parser specification, can extract the values from API responses and map them to task output parameters. The value extraction is supported for response content types XML and JSON. The type of the content that gets passed as payload and response in this API. * `json` - The type of content to be parsed, API response or device response, is inJSON format. * `xml` - The type of content to be parsed, API response or device response,is in XML format. * `text` - The type of content to be parsed, API response or device response, is inTEXT format. type: string enum: - 'json' - 'xml' - 'text' default: json x-omitempty: true Name: description: |- A reference name for this API request within the batch API request. This name shall be used to map the API output parameters to subsequent API input parameters within a batch API task. type: string x-omitempty: true Outcomes: description: |- All the possible outcomes of this API are captured here. Outcomes property is a collection property of type workflow.Outcome objects. The outcomes can be mapped to the message to be shown. The outcomes are evaluated in the order they are given. At the end of the outcomes list, an catchall success/fail outcome can be added with condition as 'true'. This is an optional property and if not specified the task will be marked as success. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true ResponseSpec: description: |- The optional grammar specification for parsing the response to extract the required values. The specification should have extraction specification specified for all the API output parameters. $ref: '#/components/schemas/content.Grammar' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SkipOnCondition: description: |- The skip expression, if provided, allows the batch API executor to skip the api execution when the given expression evaluates to true. The expression is given as such a golang template that has to be evaluated to a final content true/false. The expression is an optional and in case not provided, the API will always be executed. type: string x-omitempty: true StartDelay: description: |- The delay in seconds after which the API needs to be executed. By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution. Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out. type: integer format: int64 x-omitempty: true Timeout: description: |- The duration in seconds by which the API response is expected from the API target. If the end point does not respond for the API request within this timeout duration, the task will be marked as failed. type: integer format: int64 x-omitempty: true workflow.ArrayDataType: title: Workflow:Array Data Type description: |- This data type represents an array of a given type. It can be an array of primitive data or of custom data. x-allOf-name: workflow.ArrayDataType allOf: - # This 'workflow.ArrayDataType' class inherits all properties from its parent class workflow.BaseDataType. $ref: '#/components/schemas/workflow.BaseDataType' - # The definition of all the properties specified in this 'workflow.ArrayDataType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.ArrayDataType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.ArrayDataType' ObjectType: enum: - 'workflow.ArrayDataType' ArrayItemType: description: |- Data item within the array data type. $ref: '#/components/schemas/workflow.ArrayItem' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Max: description: |- Specify the maximum value of the array. type: integer format: int64 x-omitempty: true Min: description: |- Specify the minimum value of the array. type: integer format: int64 x-omitempty: true workflow.ArrayItem: title: Workflow:Array Item description: |- ArrayItem represents an array item within the array. x-allOf-name: workflow.ArrayItem allOf: - # This 'workflow.ArrayItem' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' workflow.AssociatedRoles: title: Workflow:Associated Roles description: |- AssociatedRoles models the inferred tasks to the required roles mapping cached in the workflow definition. x-allOf-name: workflow.AssociatedRoles allOf: - # This 'workflow.AssociatedRoles' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.AssociatedRoles' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.AssociatedRoles', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.AssociatedRoles' ObjectType: enum: - 'workflow.AssociatedRoles' Moid: description: |- Stores the identifier of the task definition for which the required roles are cached in the workflow definition. In the case of sub workflow tasks, this property stores the identifier of the workflow that is wrapped in the sub workflow task. type: string readOnly: true x-omitempty: true Roles: type: array items: description: |- Stores the identifiers of the required task roles in case of the worker task for which the roles are cached. type: string readOnly: true x-omitempty: true TaskNames: type: array items: description: |- Stores the task reference names used within the workflow that refer to the task definition. type: string readOnly: true x-omitempty: true WorkflowRoles: type: array items: description: |- Stores the required roles of the workflow definition in case of a sub workflow task. $ref: '#/components/schemas/workflow.AssociatedRoles' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true workflow.BaseDataType: title: Workflow:Base Data Type description: |- The base data type that is used to derive all the other data types for inputs and outputs. x-allOf-name: workflow.BaseDataType allOf: - # This 'workflow.BaseDataType' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.BaseDataType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.BaseDataType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Default: description: |- Default value for the data type. If default value was provided and the input was required the default value will be used as the input. $ref: '#/components/schemas/workflow.DefaultValue' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Description: description: |- Provide a detailed description of the data type. type: string x-omitempty: true Label: description: |- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ) or an underscore (_). The first and last character in label must be an alphanumeric character. type: string pattern: "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]{1,92}$" x-omitempty: true Name: description: |- Descriptive name for the data type. 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])*$" x-omitempty: true Required: description: |- Specifies whether this parameter is required. The field is applicable for task and workflow. type: boolean x-omitempty: true workflow.BatchApiExecutor.Response: description: |- The response body of a HTTP GET request for the 'workflow.BatchApiExecutor' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.BatchApiExecutor' resources. x-one-of-name: workflow.BatchApiExecutor.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.BatchApiExecutor.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.BatchApiExecutor: title: Batch API description: |- Intersight allows generic API tasks to be created by taking the API request body and a response parser specification in the form of content.Grammar object. Batch API associates the list of API requests to be executed as part of single task execution. Each API request takes the request body and a response parser specification. x-allOf-name: workflow.BatchApiExecutor allOf: - # This 'workflow.BatchApiExecutor' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.BatchApiExecutor' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.BatchApiExecutor', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.BatchApiExecutor' ObjectType: enum: - 'workflow.BatchApiExecutor' Batch: type: array items: description: |- Intersight Orchestrator supports one or a batch of APIs to be executed as part of a task execution. The batch cannot be empty. $ref: '#/components/schemas/workflow.Api' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 Constraints: description: |- Enter the constraints on when this task should match against the task definition. $ref: '#/components/schemas/workflow.TaskConstraints' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Description: description: |- A detailed description about the batch APIs. type: string x-omitempty: true Name: description: |- Name for the batch API task. type: string x-omitempty: true Outcomes: description: |- All the possible outcomes of this task are captured here. Outcomes property is a collection property of type workflow.Outcome objects. The outcomes can be mapped to the message to be shown. The outcomes are evaluated in the order they are given. At the end of the outcomes list, an catchall success/fail outcome can be added with condition as 'true'. This is an optional property and if not specified the task will be marked as success. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true Output: description: |- Intersight Orchestrator allows the extraction of required values from API responses using the API response grammar. These extracted values can be mapped to task output parameters defined in task definition. The mapping of API output parameters to the task output parameters is provided as JSON in this property. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true RetryFromFailedApi: description: |- When an execution of a nth API in the Batch fails, Retry from falied API flag indicates if the execution should start from the nth API or the first API during task retry. By default the value is set to false. type: boolean x-omitempty: true SkipOnCondition: description: |- The skip expression, if provided, allows the batch API executor to skip the task execution when the given expression evaluates to true. The expression is given as such a golang template that has to be evaluated to a final content true/false. The expression is an optional and in case not provided, the API will always be executed. type: string x-omitempty: true ErrorResponseHandler: # A Relationship to MO workflow.ErrorResponseHandler $ref: '#/components/schemas/workflow.ErrorResponseHandler.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowErrorResponseHandler resource. When the $expand query parameter is specified, the referenced resource is returned inline. TaskDefinition: # A Relationship to MO workflow.TaskDefinition $ref: '#/components/schemas/workflow.TaskDefinition.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowTaskDefinition resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.BatchApiExecutor.List: title: List of 'workflow.BatchApiExecutor' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.BatchApiExecutor' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.BatchApiExecutor' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.BatchApiExecutor' nullable: true workflow.BuildTaskMeta.Response: description: |- The response body of a HTTP GET request for the 'workflow.BuildTaskMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.BuildTaskMeta' resources. x-one-of-name: workflow.BuildTaskMeta.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.BuildTaskMeta.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.BuildTaskMeta: title: Workflow:Build Task Meta description: |- Contains relationship for tasks within a workflow. It is used to dynamically generate a workflow. x-allOf-name: workflow.BuildTaskMeta allOf: - # This 'workflow.BuildTaskMeta' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.BuildTaskMeta' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.BuildTaskMeta', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.BuildTaskMeta' ObjectType: enum: - 'workflow.BuildTaskMeta' Name: description: |- Name for the BuildTaskMeta instance used to created a dynamic workflow. type: string readOnly: true x-omitempty: true Src: description: |- Microservice owner for the task in this workflow. type: string readOnly: true x-omitempty: true TaskList: description: |- Task list used to build the dynamic workflow. # Property is any value, it may be the null value, an object or array. nullable: true readOnly: true x-omitempty: true TaskType: description: |- The type of the task within this workflow. type: string readOnly: true x-omitempty: true WorkflowType: description: |- The type for the dynamic workflow. type: string readOnly: true x-omitempty: true workflow.BuildTaskMeta.List: title: List of 'workflow.BuildTaskMeta' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.BuildTaskMeta' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.BuildTaskMeta' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.BuildTaskMeta' nullable: true workflow.BuildTaskMetaOwner.Response: description: |- The response body of a HTTP GET request for the 'workflow.BuildTaskMetaOwner' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.BuildTaskMetaOwner' resources. x-one-of-name: workflow.BuildTaskMetaOwner.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.BuildTaskMetaOwner.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.BuildTaskMetaOwner: title: Workflow:Build Task Meta Owner description: |- Contains the list of dynamic workflow types that a microservice supports. x-allOf-name: workflow.BuildTaskMetaOwner allOf: - # This 'workflow.BuildTaskMetaOwner' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.BuildTaskMetaOwner' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.BuildTaskMetaOwner', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.BuildTaskMetaOwner' ObjectType: enum: - 'workflow.BuildTaskMetaOwner' Service: description: |- The microservice owner responsible for the tasks. type: string readOnly: true x-omitempty: true WorkflowTypes: type: array items: description: |- The list of workflow types supported by the microservice. type: string readOnly: true x-omitempty: true workflow.BuildTaskMetaOwner.List: title: List of 'workflow.BuildTaskMetaOwner' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.BuildTaskMetaOwner' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.BuildTaskMetaOwner' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.BuildTaskMetaOwner' nullable: true workflow.Catalog.Response: description: |- The response body of a HTTP GET request for the 'workflow.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.Catalog' resources. x-one-of-name: workflow.Catalog.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.Catalog.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.Catalog.Relationship: description: A relationship to the 'workflow.Catalog' resource, or the expanded 'workflow.Catalog' resource, or the 'null' value. x-one-of-name: workflow.Catalog.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/workflow.Catalog' workflow.Catalog: title: Workflow:Catalog description: |- A catalog of workflow related objects such as workflow and task definitions. Each user account will have a local workflow catalog where account users can store their private workflow and task definitions. Cisco provides validated workflows and tasks to Intersight users via shared catalogs. Intersight users will be able to read, run these workflows and tasks within their account context. The shared catalogs will be managed entirely by Cisco. Contributions to shared catalogs will need to be provided to Cisco who will publish them at their own discretion. x-allOf-name: workflow.Catalog allOf: - # This 'workflow.Catalog' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.Catalog' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.Catalog', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.Catalog' ObjectType: enum: - 'workflow.Catalog' Name: description: |- A unique name for the catalog. type: string x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.Catalog.List: title: List of 'workflow.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 'workflow.Catalog' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.Catalog' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.Catalog' nullable: true workflow.CliCommand: title: CLI Command description: |- This models a single CLI command that can be executed on the end point. x-allOf-name: workflow.CliCommand allOf: - # This 'workflow.CliCommand' class inherits all properties from its parent class workflow.Api. $ref: '#/components/schemas/workflow.Api' - # The definition of all the properties specified in this 'workflow.CliCommand' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.CliCommand', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.CliCommand' ObjectType: enum: - 'workflow.CliCommand' Command: description: |- The command to run on the device connector. type: string x-omitempty: true EndPrompt: description: |- The regex string that identifies the end of the command response. type: string x-omitempty: true ExpectPrompts: type: array items: description: |- Cli prompts required as part of interactive command execution. For e.g. login credentials will be part of prompts which are provided as list of expect prompt regex and corresponding answer string. $ref: '#/components/schemas/workflow.ExpectPrompt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SkipStatusCheck: description: |- Skips the execution status check of the terminal command. One use case for this is while exiting the terminal session from esxi host. type: boolean x-omitempty: true TerminalEnd: description: |- If this flag is set, it marks the end of the terminal session where the previous commands were executed. type: boolean x-omitempty: true TerminalStart: description: |- If this flag is set, the execution of this command initiates a terminal session in which the subsequent CLI commands are executed until a command with terminalEnd flag is encountered or the end of the batch. type: boolean x-omitempty: true Type: description: |- The type of the command - can be interactive or non-interactive. * `NonInteractive` - The CLI command is not an interactive command. * `Interactive` - The CLI command is executed in interactive mode and the command must provide the expects andanswers. type: string enum: - 'NonInteractive' - 'Interactive' default: NonInteractive x-omitempty: true workflow.Constraints: title: Workflow:Constraints description: |- Captures the constraints for valid parameter values. x-allOf-name: workflow.Constraints allOf: - # This 'workflow.Constraints' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.Constraints' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.Constraints', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.Constraints' ObjectType: enum: - 'workflow.Constraints' EnumList: type: array items: description: |- When the parameter is a enum then this list of enum entry is used to validate the input belongs to one of items in the list. $ref: '#/components/schemas/workflow.EnumEntry' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Max: description: |- Allowed maximum value of the parameter if parameter is integer/float or maximum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. type: number format: double x-omitempty: true Min: description: |- Allowed minimum value of the parameter if parameter is integer/float or minimum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. type: number format: double x-omitempty: true Regex: description: |- When the parameter is a string this regular expression is used to ensure the value is valid. type: string x-omitempty: true workflow.ControlTask: title: Workflow:Control Task description: |- Control tasks run within the workflow engine and are not executed by remote worker microservices. They are used to modify flow of control within a workflow. x-allOf-name: workflow.ControlTask allOf: - # This 'workflow.ControlTask' class inherits all properties from its parent class workflow.WorkflowTask. $ref: '#/components/schemas/workflow.WorkflowTask' workflow.CustomArrayItem: title: Workflow:Custom Array Item description: |- Captures an array of custom datatype items. x-allOf-name: workflow.CustomArrayItem allOf: - # This 'workflow.CustomArrayItem' class inherits all properties from its parent class workflow.ArrayItem. $ref: '#/components/schemas/workflow.ArrayItem' - # The definition of all the properties specified in this 'workflow.CustomArrayItem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.CustomArrayItem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.CustomArrayItem' ObjectType: enum: - 'workflow.CustomArrayItem' Properties: description: |- Captures an array item which is of custom data type. $ref: '#/components/schemas/workflow.CustomDataProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.CustomDataProperty: title: Workflow:Custom Data Property description: |- Capture all the properties for Custom data type. x-allOf-name: workflow.CustomDataProperty allOf: - # This 'workflow.CustomDataProperty' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.CustomDataProperty' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.CustomDataProperty', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.CustomDataProperty' ObjectType: enum: - 'workflow.CustomDataProperty' CatalogMoid: description: |- Specify the catalog moid that this custom data type belongs. type: string x-omitempty: true CustomDataTypeId: description: |- The resolved custom data type definition managed object. type: string readOnly: true x-omitempty: true CustomDataTypeName: description: |- Name of the custom data type for this input. type: string x-omitempty: true workflow.CustomDataType: title: Workflow:Custom Data Type description: |- This data type represents a custom data object. x-allOf-name: workflow.CustomDataType allOf: - # This 'workflow.CustomDataType' class inherits all properties from its parent class workflow.BaseDataType. $ref: '#/components/schemas/workflow.BaseDataType' - # The definition of all the properties specified in this 'workflow.CustomDataType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.CustomDataType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.CustomDataType' ObjectType: enum: - 'workflow.CustomDataType' Properties: description: |- Captures the custom data type properties. $ref: '#/components/schemas/workflow.CustomDataProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.CustomDataTypeDefinition.Response: description: |- The response body of a HTTP GET request for the 'workflow.CustomDataTypeDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.CustomDataTypeDefinition' resources. x-one-of-name: workflow.CustomDataTypeDefinition.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.CustomDataTypeDefinition.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.CustomDataTypeDefinition: title: Custom Datatype description: |- Captures a customized data type definition that can be used for task or workflow input/output. This can be reused across multiple tasks and workflow definitions. x-allOf-name: workflow.CustomDataTypeDefinition allOf: - # This 'workflow.CustomDataTypeDefinition' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.CustomDataTypeDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.CustomDataTypeDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.CustomDataTypeDefinition' ObjectType: enum: - 'workflow.CustomDataTypeDefinition' CompositeType: description: |- When true this data type definition is a collection of type definitions to represent composite data like JSON. type: boolean x-omitempty: true Description: description: |- A human-friendly description of this custom data type indicating it's domain and usage. type: string x-omitempty: true Label: description: |- A user friendly short name to identify the custom data type definition. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote ('), or an underscore (_). type: string pattern: "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]{1,92}$" x-omitempty: true Name: description: |- The name of custom data type definition. The valid name can contain lower case and upper case alphabetic characters, digits and special characters '-' and '_'. type: string pattern: "^[a-zA-Z0-9_-]{1,64}$" x-createOnly: true x-omitempty: true TypeDefinition: type: array items: description: |- The properties of this custom data type definition. $ref: '#/components/schemas/workflow.BaseDataType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Catalog: # A Relationship to MO workflow.Catalog $ref: '#/components/schemas/workflow.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.CustomDataTypeDefinition.List: title: List of 'workflow.CustomDataTypeDefinition' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.CustomDataTypeDefinition' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.CustomDataTypeDefinition' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.CustomDataTypeDefinition' nullable: true workflow.DecisionCase: title: Workflow:Decision Case description: |- A Decision Case is a condition for a Decision Task. It is the equivalent of case statement in the programming language paradigm of switch and case. x-allOf-name: workflow.DecisionCase allOf: - # This 'workflow.DecisionCase' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.DecisionCase' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.DecisionCase', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.DecisionCase' ObjectType: enum: - 'workflow.DecisionCase' Description: description: |- Description of this decision case. type: string x-omitempty: true NextTask: description: |- The name of the next task (Task names unique within workflow) to run. In a graph model, denotes an edge to another Task Node. type: string x-omitempty: true Value: description: |- Value for the decision case. type: string x-omitempty: true workflow.DecisionTask: title: Workflow:Decision Task description: |- A DecisionTask is a control task that executes a sequence of WorkflowTasks based off decision provided and evaluated by this task. x-allOf-name: workflow.DecisionTask allOf: - # This 'workflow.DecisionTask' class inherits all properties from its parent class workflow.ControlTask. $ref: '#/components/schemas/workflow.ControlTask' - # The definition of all the properties specified in this 'workflow.DecisionTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.DecisionTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.DecisionTask' ObjectType: enum: - 'workflow.DecisionTask' Condition: description: |- The condition to evaluate for this decision task. The condition can be a workflow or task variable or an expression based on the input parameters. Example value for condition if its Workflow/task variable is - "${task1.output.var1} or ${workflow.input.var2}" which evaluates to a value matching any of the decision case values. Example value for condition if its an expression is - "if ( $.element ! = null && $.element > 0 ) 'true'; else 'false'; " which evaluates to 'true' or 'false' and will match one of the decision case values. Here "element" is a variable in decisiontask's inputParameters JSON formatted map. You can also use javascript like functions indexOf, toUpperCase in the expression which will be evaluated by the expression evaluator. type: string x-omitempty: true DecisionCases: type: array items: description: |- A list of potential decision task flows based off a condition. $ref: '#/components/schemas/workflow.DecisionCase' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true DefaultTask: description: |- The default next Task to execute if the decision cannot be evaluated to any of the DecisionCases. type: string x-omitempty: true InputParameters: description: |- JSON formatted map that defines the input given to the decision task. The inputs are used as variables in the condition property of decision task. The input variables can be static values like "hello" , "24", "true" OR previous task outputs/workflow inputs like "${task2.output.var1}}". The input variables are referrenced as $.inputVariableName in the condition property. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true workflow.DefaultValue: title: Workflow:Default Value description: |- Captures default vales for a data type. x-allOf-name: workflow.DefaultValue allOf: - # This 'workflow.DefaultValue' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.DefaultValue' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.DefaultValue', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.DefaultValue' ObjectType: enum: - 'workflow.DefaultValue' Override: description: |- Override the default value provided for the data type. When true, allow the user to enter value for the data type. type: boolean x-omitempty: true Value: description: |- Default value for the data type. If default value was provided and the input was required the default value will be used as the input. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true workflow.DynamicWorkflowActionTaskList: title: Workflow:Dynamic Workflow Action Task List description: |- Keeps a list of the tasks to add for a corresponding workflow action when PendingDynamicWorkflowInfo is built. x-allOf-name: workflow.DynamicWorkflowActionTaskList allOf: - # This 'workflow.DynamicWorkflowActionTaskList' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.DynamicWorkflowActionTaskList' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.DynamicWorkflowActionTaskList', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.DynamicWorkflowActionTaskList' ObjectType: enum: - 'workflow.DynamicWorkflowActionTaskList' Action: description: |- The action of the Dynamic Workflow. type: string x-omitempty: true Tasks: description: |- The task list that has precedence which dictates how the workflow should be constructed. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true workflow.EndTask: title: Workflow:End Task description: |- An EndTask denotes the completion of a workflow. x-allOf-name: workflow.EndTask allOf: - # This 'workflow.EndTask' class inherits all properties from its parent class workflow.ControlTask. $ref: '#/components/schemas/workflow.ControlTask' workflow.EnumEntry: title: Workflow:Enum Entry description: |- Captures a single enum entry which has a label and value. x-allOf-name: workflow.EnumEntry allOf: - # This 'workflow.EnumEntry' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.EnumEntry' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.EnumEntry', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.EnumEntry' ObjectType: enum: - 'workflow.EnumEntry' Label: description: |- Label for the enum value. A user friendly short string to identify the enum value. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote ('), forward slash (/), or an underscore (_). type: string pattern: "^[a-zA-Z0-9]+[+\\s\\/a-zA-Z0-9_'.:-]{1,92}$" x-omitempty: true Value: description: |- Enum value for this enum entry. Value will be passed to the workflow as string type for execution. Value can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_). type: string pattern: "^[a-zA-Z0-9_.:-]*[+\\s\\/a-zA-Z0-9_.:-]{1,64}$" x-omitempty: true workflow.ErrorResponseHandler.Response: description: |- The response body of a HTTP GET request for the 'workflow.ErrorResponseHandler' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.ErrorResponseHandler' resources. x-one-of-name: workflow.ErrorResponseHandler.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.ErrorResponseHandler.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.ErrorResponseHandler.Relationship: description: A relationship to the 'workflow.ErrorResponseHandler' resource, or the expanded 'workflow.ErrorResponseHandler' resource, or the 'null' value. x-one-of-name: workflow.ErrorResponseHandler.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/workflow.ErrorResponseHandler' workflow.ErrorResponseHandler: title: Error Response Handler description: |- Intersight allows generic API tasks to be created by taking the API request body and a response parser specification in the form of content.Grammar object. Error Response Handler allows to create a generic error response specification which can be used by multiple Batch API. The parameters provided in the Error Response Handler may be used to parse error responses from an API request, if the response specification provided for the API request does not define error parameters. x-allOf-name: workflow.ErrorResponseHandler allOf: - # This 'workflow.ErrorResponseHandler' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.ErrorResponseHandler' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.ErrorResponseHandler', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.ErrorResponseHandler' ObjectType: enum: - 'workflow.ErrorResponseHandler' Description: description: |- A detailed description about the error response handler. type: string x-omitempty: true Name: description: |- Name for the error response handler. type: string pattern: "^[a-zA-Z0-9_.:-]{1,64}$" x-omitempty: true Parameters: type: array items: description: |- Collection of parameters present in error response from the endpoint. $ref: '#/components/schemas/content.Parameter' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true PlatformType: description: |- The platform type for which the error response handler is defined. * `` - The device reported an empty or unrecognized platform type. * `APIC` - An Application Policy Infrastructure Controller cluster. * `DCNM` - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * `UCSFI` - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * `UCSFIISM` - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * `IMC` - A standalone UCS Server Integrated Management Controller. * `IMCM4` - A standalone UCS M4 Server. * `IMCM5` - A standalone UCS M5 server. * `UCSIOM` - An UCS Chassis IO module. * `HX` - A HyperFlex storage controller. * `HyperFlexAP` - A HyperFlex Application Platform. * `UCSD` - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * `IntersightAppliance` - Intersight on-premise appliance. * `PureStorageFlashArray` - A Pure Storage FlashArray device. * `NetAppOntap` - A NetApp ONTAP storage system. * `EmcScaleIo` - An EMC ScaleIO storage system. * `EmcVmax` - An EMC VMAX storage system. * `EmcVplex` - An EMC VPLEX storage system. * `EmcXtremIo` - An EMC XtremIO storage system. * `VmwareVcenter` - A VMware vCenter device that manages Virtual Machines. * `MicrosoftHyperV` - A Microsoft HyperV system that manages Virtual Machines. * `AppDynamics` - An AppDynamics controller that monitors applications. * `Dynatrace` - A Dynatrace controller that monitors applications. * `MicrosoftSqlServer` - A Microsoft SQL database server. * `Kubernetes` - A Kubernetes cluster that runs containerized applications. * `MicrosoftAzure` - A Microsoft Azure target. * `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * `IMCBlade` - An Intersight managed UCS Blade Server. type: string enum: - '' - 'APIC' - 'DCNM' - 'UCSFI' - 'UCSFIISM' - 'IMC' - 'IMCM4' - 'IMCM5' - 'UCSIOM' - 'HX' - 'HyperFlexAP' - 'UCSD' - 'IntersightAppliance' - 'PureStorageFlashArray' - 'NetAppOntap' - 'EmcScaleIo' - 'EmcVmax' - 'EmcVplex' - 'EmcXtremIo' - 'VmwareVcenter' - 'MicrosoftHyperV' - 'AppDynamics' - 'Dynatrace' - 'MicrosoftSqlServer' - 'Kubernetes' - 'MicrosoftAzure' - 'ServiceEngine' - 'IMCBlade' default: "" x-omitempty: true Types: type: array items: description: |- The collection of complex types definitions used in this Error Response Handler This is required only if any of the parameters provided in this Error Response Handler is of complex type. $ref: '#/components/schemas/content.ComplexType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Catalog: # A Relationship to MO workflow.Catalog $ref: '#/components/schemas/workflow.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.ErrorResponseHandler.List: title: List of 'workflow.ErrorResponseHandler' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.ErrorResponseHandler' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.ErrorResponseHandler' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.ErrorResponseHandler' nullable: true workflow.ExpectPrompt: title: Expect Prompt description: |- This models a single expect and answer prompt of the interactive command. x-allOf-name: workflow.ExpectPrompt allOf: - # This 'workflow.ExpectPrompt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.ExpectPrompt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.ExpectPrompt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.ExpectPrompt' ObjectType: enum: - 'workflow.ExpectPrompt' Expect: description: |- The regex of the expect prompt of the interactive command. type: string x-omitempty: true Send: description: |- The answer string to the expect prompt. type: string x-omitempty: true workflow.FailureEndTask: title: Workflow:Failure End Task description: |- A FailureEndTask denotes the failed completion of a workflow. x-allOf-name: workflow.FailureEndTask allOf: - # This 'workflow.FailureEndTask' class inherits all properties from its parent class workflow.EndTask. $ref: '#/components/schemas/workflow.EndTask' workflow.FileTransfer: title: File Transfer description: |- Message to transfer a file from Intersight connected device to remote server. x-allOf-name: workflow.FileTransfer allOf: - # This 'workflow.FileTransfer' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'workflow.FileTransfer' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.FileTransfer', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.FileTransfer' ObjectType: enum: - 'workflow.FileTransfer' DestinationFilePath: description: |- Destination file path on the target server. type: string x-omitempty: true FileMode: description: |- File permission to set on the transferred file. type: integer format: int64 x-omitempty: true SourceFilePath: description: |- Source file path on the Intersight connected device. type: string x-omitempty: true workflow.ForkTask: title: Workflow:Fork Task description: |- A ForkTask is a control task that forks tasks for parallel execution in a workflow. x-allOf-name: workflow.ForkTask allOf: - # This 'workflow.ForkTask' class inherits all properties from its parent class workflow.ControlTask. $ref: '#/components/schemas/workflow.ControlTask' - # The definition of all the properties specified in this 'workflow.ForkTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.ForkTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.ForkTask' ObjectType: enum: - 'workflow.ForkTask' ForkedTasks: type: array items: description: |- List of forked task names where the tasks in the list will be started in parallel and each task sequence in the forked task list will be run in sequence. OnFailure transition within fork task is not honored and when tasks within fork fail the workflow will fail. type: string x-omitempty: true JoinTask: description: |- Task name for the join control task that must follow a fork control task. type: string x-omitempty: true workflow.InitiatorContext: title: Workflow:Initiator Context description: |- Details about the workflow initiator name, type, initiator object Id if present and the result handler. x-allOf-name: workflow.InitiatorContext allOf: - # This 'workflow.InitiatorContext' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.InitiatorContext' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.InitiatorContext', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.InitiatorContext' ObjectType: enum: - 'workflow.InitiatorContext' InitiatorMoid: description: |- The moid of the Intersigt managed object that initiated the workflow. type: string x-omitempty: true InitiatorName: description: |- Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow. type: string x-omitempty: true InitiatorType: description: |- Type of Intersight managed object that initiated the workflow. type: string x-omitempty: true workflow.InternalProperties: title: Workflow:Internal Properties description: |- Internal properties for a task definition which are not editable by the user. x-allOf-name: workflow.InternalProperties allOf: - # This 'workflow.InternalProperties' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.InternalProperties' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.InternalProperties', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.InternalProperties' ObjectType: enum: - 'workflow.InternalProperties' BaseTaskType: description: |- This field will hold the base task type like HttpBaseTask or RemoteAnsibleBaseTask. type: string readOnly: true x-omitempty: true Constraints: description: |- This field will hold any constraints a concrete task definition will specify in order to limit the environment where the task can execute. $ref: '#/components/schemas/workflow.TaskConstraints' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Internal: description: |- Denotes this is an internal task. Internal tasks will be hidden from the UI when executing a workflow. type: boolean readOnly: true x-omitempty: true Owner: description: |- The service that owns and is responsible for execution of the task. type: string readOnly: true x-omitempty: true workflow.JoinTask: title: Workflow:Join Task description: |- A JoinTask is a control task that must follow a fork task and specify all the fork tasks that must complete and join before the worfklow can proceed to the task specified in the OnSuccess transition. x-allOf-name: workflow.JoinTask allOf: - # This 'workflow.JoinTask' class inherits all properties from its parent class workflow.ControlTask. $ref: '#/components/schemas/workflow.ControlTask' - # The definition of all the properties specified in this 'workflow.JoinTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.JoinTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.JoinTask' ObjectType: enum: - 'workflow.JoinTask' JoinOnTasks: type: array items: description: |- List of tasks which must complete before the task specified in OnSuccess transition will be scheduled for execution. If the last task in a fork list is not specified in this list of joinOnTasks then the engine does not wait for that forked task list to complete and the result of that task execution does not affect the workflow execution result. type: string readOnly: true x-omitempty: true OnSuccess: description: |- Name of the next task to run if all fork path specified in the JoinOnTasks list succeeds which is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node. type: string x-omitempty: true workflow.LoopTask: title: Workflow:Loop Task description: |- A LoopTask is a control task that runs one or more task multiple times based on a counter. The tasks can be run in serial or parallel. x-allOf-name: workflow.LoopTask allOf: - # This 'workflow.LoopTask' class inherits all properties from its parent class workflow.ControlTask. $ref: '#/components/schemas/workflow.ControlTask' - # The definition of all the properties specified in this 'workflow.LoopTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.LoopTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.LoopTask' ObjectType: enum: - 'workflow.LoopTask' Count: description: |- Count value for the loop, this can be a constant or an expression which will evaluate to an integer value. Example, Use the length of the input A which is an array. Count must be less than or equal to 500. type: string x-omitempty: true LoopStartTask: description: |- Start task where the list of tasks will be executed multiple times based on the count value. type: string x-omitempty: true NumberOfBatches: description: |- When tasks are run in parallel and the count is large, the actual number of task run in parallel can be controlled by this property. If count is 100 and numberOfBatches is 5 then 20 tasks are run in parallel 5 times. Parallel batch size must be less than the count. In cases where count is dynamic and depends on input given during workflow execution, if that count is less than batch then empty batches might get created which do not have any tasks under them. type: integer format: int64 minimum: 1 x-omitempty: true OnSuccess: description: |- This specifies the name of the next task to run if all iterations of the loop task succeeds. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node. type: string x-omitempty: true Parallel: description: |- When set to true the loop will run in parallel else it will run in a serial fashion. Only one task is supported inside the loop task when the loop is run in parallel. Subworkflow can be used inside the single loop task to build complex conditions. type: boolean x-omitempty: true workflow.Message: title: Workflow:Message description: |- Intermediate Task or Workflow message with severity. x-allOf-name: workflow.Message allOf: - # This 'workflow.Message' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.Message' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.Message', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.Message' ObjectType: enum: - 'workflow.Message' Message: description: |- An i18n message that can be translated in multiple languages to support internationalization. type: string x-omitempty: true Severity: description: |- The severity of the Task or Workflow message warning/error/info etc. * `Info` - The enum represents the log level to be used to convey info message. * `Warning` - The enum represents the log level to be used to convey warning message. * `Debug` - The enum represents the log level to be used to convey debug message. * `Error` - The enum represents the log level to be used to convey error message. type: string enum: - 'Info' - 'Warning' - 'Debug' - 'Error' default: Info x-omitempty: true workflow.MoReferenceArrayItem: title: Workflow:Mo Reference Array Item description: |- MoReferenceArrayItem is used to create an array of MoReference datatype. x-allOf-name: workflow.MoReferenceArrayItem allOf: - # This 'workflow.MoReferenceArrayItem' class inherits all properties from its parent class workflow.ArrayItem. $ref: '#/components/schemas/workflow.ArrayItem' - # The definition of all the properties specified in this 'workflow.MoReferenceArrayItem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.MoReferenceArrayItem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.MoReferenceArrayItem' ObjectType: enum: - 'workflow.MoReferenceArrayItem' Properties: type: array items: description: |- Captures an array item which is of MoReference data type. $ref: '#/components/schemas/workflow.MoReferenceProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.MoReferenceDataType: title: Workflow:Mo Reference Data Type description: |- Data type to capture an Intersight Managed object reference. x-allOf-name: workflow.MoReferenceDataType allOf: - # This 'workflow.MoReferenceDataType' class inherits all properties from its parent class workflow.BaseDataType. $ref: '#/components/schemas/workflow.BaseDataType' - # The definition of all the properties specified in this 'workflow.MoReferenceDataType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.MoReferenceDataType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.MoReferenceDataType' ObjectType: enum: - 'workflow.MoReferenceDataType' Properties: type: array items: description: |- List of managed object references. $ref: '#/components/schemas/workflow.MoReferenceProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true minItems: 1 workflow.MoReferenceProperty: title: Workflow:Mo Reference Property description: |- Capture all the properties for an Intersight managed object reference. x-allOf-name: workflow.MoReferenceProperty allOf: - # This 'workflow.MoReferenceProperty' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.MoReferenceProperty' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.MoReferenceProperty', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.MoReferenceProperty' ObjectType: enum: - 'workflow.MoReferenceProperty' DisplayAttributes: type: array items: description: |- List of properties from an Intersight object which can help to identify the object. Typically the set of identity constraints on the object can be listed here to help the user identity the managed object. type: string x-omitempty: true minItems: 1 Selector: description: |- Field to hold an Intersight API along with an optional filter to narrow down the search options. type: string pattern: "^$|/api/v1/.*" x-omitempty: true ValueAttribute: description: |- A property from the Intersight object, value of which can be used as value for referenced input definition. type: string x-omitempty: true workflow.PendingDynamicWorkflowInfo.Response: description: |- The response body of a HTTP GET request for the 'workflow.PendingDynamicWorkflowInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.PendingDynamicWorkflowInfo' resources. x-one-of-name: workflow.PendingDynamicWorkflowInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.PendingDynamicWorkflowInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.PendingDynamicWorkflowInfo.Relationship: description: A relationship to the 'workflow.PendingDynamicWorkflowInfo' resource, or the expanded 'workflow.PendingDynamicWorkflowInfo' resource, or the 'null' value. x-one-of-name: workflow.PendingDynamicWorkflowInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/workflow.PendingDynamicWorkflowInfo' workflow.PendingDynamicWorkflowInfo: title: Workflow:Pending Dynamic Workflow Info description: |- Information for a pending Dynamic Workflow Instance before it is run. Validation needs to be done on the dynamic workflow tasks before starting. After it begins, it will be tracked with regular WorkflowInstance. x-allOf-name: workflow.PendingDynamicWorkflowInfo allOf: - # This 'workflow.PendingDynamicWorkflowInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.PendingDynamicWorkflowInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.PendingDynamicWorkflowInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.PendingDynamicWorkflowInfo' ObjectType: enum: - 'workflow.PendingDynamicWorkflowInfo' Input: description: |- The inputs of the workflow. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true Name: description: |- A name for the pending dynamic workflow. type: string x-omitempty: true PendingServices: type: array items: description: |- The pending services the dynamic workflow is waiting for to return the task list. type: string x-omitempty: true Src: description: |- The src is workflow owner service. type: string x-omitempty: true Status: description: |- The current status of the PendingDynamicWorkflowInfo. * `GatheringTasks` - Dynamic workflow is gathering tasks before workflow can start execution. * `Waiting` - Dynamic workflow is in waiting state and not yet started execution. type: string enum: - 'GatheringTasks' - 'Waiting' default: GatheringTasks x-omitempty: true WaitOnDuplicate: description: |- When set to true workflow engine will wait for a duplicate to finish before starting a new one. type: boolean x-omitempty: true WorkflowActionTaskLists: type: array items: description: |- The task lists returned by services for building dynamic workflows. There will be an entry for every different workflow action. $ref: '#/components/schemas/workflow.DynamicWorkflowActionTaskList' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true WorkflowCtx: description: |- The workflow's workflow context which contains initiator and target information. $ref: '#/components/schemas/workflow.WorkflowCtx' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true WorkflowKey: description: |- This key contains workflow, initiator and target name. Workflow engine uses the key to do workflow dedup. type: string x-omitempty: true WorkflowMeta: description: |- The metadata of the workflow. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true WorkflowInfo: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true workflow.PendingDynamicWorkflowInfo.List: title: List of 'workflow.PendingDynamicWorkflowInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.PendingDynamicWorkflowInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.PendingDynamicWorkflowInfo' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.PendingDynamicWorkflowInfo' nullable: true workflow.PrimitiveArrayItem: title: Workflow:Primitive Array Item description: |- PrimitiveArrayItem is used to create an array of primitive datatype. In order to create an array of strings, integers or float use PrimitiveArrayItem object type within the array. x-allOf-name: workflow.PrimitiveArrayItem allOf: - # This 'workflow.PrimitiveArrayItem' class inherits all properties from its parent class workflow.ArrayItem. $ref: '#/components/schemas/workflow.ArrayItem' - # The definition of all the properties specified in this 'workflow.PrimitiveArrayItem' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.PrimitiveArrayItem', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.PrimitiveArrayItem' ObjectType: enum: - 'workflow.PrimitiveArrayItem' Properties: description: |- Captures an array item which is of primitive data type. $ref: '#/components/schemas/workflow.PrimitiveDataProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.PrimitiveDataProperty: title: Workflow:Primitive Data Property description: |- Capture all the properties for primitive data type. x-allOf-name: workflow.PrimitiveDataProperty allOf: - # This 'workflow.PrimitiveDataProperty' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.PrimitiveDataProperty' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.PrimitiveDataProperty', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.PrimitiveDataProperty' ObjectType: enum: - 'workflow.PrimitiveDataProperty' Constraints: description: |- Constraints that must be applied to the parameter value supplied for this data type. $ref: '#/components/schemas/workflow.Constraints' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true InventorySelector: type: array items: description: |- List of Intersight managed object selectors. The workflow execution user interface show objects from inventory that are matching the selectors to help with selecting inputs. $ref: '#/components/schemas/workflow.MoReferenceProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Secure: description: |- Intersight supports secure properties as task input/output. The values of these properties are encrypted and stored in Intersight. This flag marks the property to be secure when it is set to true. type: boolean x-createOnly: true x-omitempty: true Type: description: |- Specify the enum type for primitive data type. * `string` - Enum to specify a string data type. * `integer` - Enum to specify an integer32 data type. * `float` - Enum to specify a float64 data type. * `boolean` - Enum to specify a boolean data type. * `json` - Enum to specify a json data type. * `enum` - Enum to specify a enum data type which is a list of pre-defined strings. type: string enum: - 'string' - 'integer' - 'float' - 'boolean' - 'json' - 'enum' default: string x-omitempty: true workflow.PrimitiveDataType: title: Workflow:Primitive Data Type description: |- This data type is used to represent primitives like string, floats and integers. x-allOf-name: workflow.PrimitiveDataType allOf: - # This 'workflow.PrimitiveDataType' class inherits all properties from its parent class workflow.BaseDataType. $ref: '#/components/schemas/workflow.BaseDataType' - # The definition of all the properties specified in this 'workflow.PrimitiveDataType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.PrimitiveDataType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.PrimitiveDataType' ObjectType: enum: - 'workflow.PrimitiveDataType' Properties: description: |- Primitive data type properties. $ref: '#/components/schemas/workflow.PrimitiveDataProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.Properties: title: Workflow:Properties description: |- Properties for the task definition like the inputs, outputs, timeout and retry policies. Tasks are the building blocks for workflows. x-allOf-name: workflow.Properties allOf: - # This 'workflow.Properties' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.Properties' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.Properties', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.Properties' ObjectType: enum: - 'workflow.Properties' ExternalMeta: description: |- When set to false the task definition can only be used by internal system workflows. When set to true then the task can be included in user defined workflows. type: boolean x-createOnly: true x-omitempty: true InputDefinition: type: array items: description: |- The schema expected for input parameters for this task. $ref: '#/components/schemas/workflow.BaseDataType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true OutputDefinition: type: array items: description: |- The schema expected for output parameters for this task. $ref: '#/components/schemas/workflow.BaseDataType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true RetryCount: description: |- The number of times a task should be tried before marking as failed. type: integer format: int64 minimum: 0 maximum: 256 x-omitempty: true RetryDelay: description: |- The delay in seconds after which the the task is re-tried. type: integer format: int64 minimum: 10 maximum: 86400 x-omitempty: true RetryPolicy: description: |- The retry policy for the task. * `Fixed` - The enum specifies the option as Fixed where the task retry happens after fixed time specified by RetryDelay. type: string enum: - 'Fixed' default: Fixed x-omitempty: true SupportStatus: description: |- Supported status of the definition. * `Supported` - The definition is a supported version and there will be no changes to the mandatory inputs or outputs. * `Beta` - The definition is a Beta version and this version can under go changes until the version is marked supported. * `Deprecated` - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added. type: string enum: - 'Supported' - 'Beta' - 'Deprecated' default: Supported x-omitempty: true Timeout: description: |- The timeout value in seconds after which task will be marked as timed out. Max allowed value is 7 days. type: integer format: int64 minimum: 10 maximum: 604800 x-omitempty: true TimeoutPolicy: description: |- The timeout policy for the task. * `Timeout` - The enum specifies the option as Timeout where task will be timed out after the specified time in Timeout property. * `Retry` - The enum specifies the option as Retry where task will be re-tried. type: string enum: - 'Timeout' - 'Retry' default: Timeout x-omitempty: true workflow.ResultHandler: title: Workflow:Result Handler description: |- The result handler service details. x-allOf-name: workflow.ResultHandler allOf: - # This 'workflow.ResultHandler' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' workflow.SshCmd: title: SSH Cmd description: |- SSH command to execute on the remote server. x-allOf-name: workflow.SshCmd allOf: - # This 'workflow.SshCmd' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'workflow.SshCmd' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.SshCmd', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.SshCmd' ObjectType: enum: - 'workflow.SshCmd' Command: description: |- SSH command to execute on the remote server. type: string x-omitempty: true CommandType: description: |- SSH command type to execute on the remote server. * `NonInteractiveCmd` - Execute a non-interactive SSH command on the remote server. * `InteractiveCmd` - Execute an interactive SSH command on the remote server. type: string enum: - 'NonInteractiveCmd' - 'InteractiveCmd' default: NonInteractiveCmd x-omitempty: true ExpectPrompts: type: array items: description: |- SSH prompts required as part of command execution. It is a collection of ExpectPrompt complex type. $ref: '#/components/schemas/connector.ExpectPrompt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true ShellPrompt: description: |- Regex of the remote server's shell prompt. type: string x-omitempty: true ShellPromptTimeout: description: |- Expect timeout value in seconds for the shell prompt. type: integer format: int64 x-omitempty: true workflow.SshConfig: title: Ssh Config description: |- Carries the SSH session details for opening a new connection. x-allOf-name: workflow.SshConfig allOf: - # This 'workflow.SshConfig' class inherits all properties from its parent class connector.BaseMessage. $ref: '#/components/schemas/connector.BaseMessage' - # The definition of all the properties specified in this 'workflow.SshConfig' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.SshConfig', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.SshConfig' ObjectType: enum: - 'workflow.SshConfig' Password: description: |- Password to use in the SSH connection credentials (If empty then private key will be used). type: string writeOnly: true x-omitempty: true Target: description: |- The remote server to connect to. IPv4 address represented in dot decimal notation. type: string x-omitempty: true User: description: |- Username for the remote SSH connection. type: string x-omitempty: true workflow.SshSession: title: SSH Session description: |- This models a single SSH session from Intersight connected endpoint to a remote server. Multiple SSH operations can be run sequentially over a single SSH session. x-allOf-name: workflow.SshSession allOf: - # This 'workflow.SshSession' class inherits all properties from its parent class workflow.Api. $ref: '#/components/schemas/workflow.Api' - # The definition of all the properties specified in this 'workflow.SshSession' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.SshSession', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.SshSession' ObjectType: enum: - 'workflow.SshSession' FileTransferToRemote: description: |- Message to transfer a file from Intersight connected device to remote server. $ref: '#/components/schemas/workflow.FileTransfer' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MessageType: description: |- The type of SSH message to send to the remote server. * `ExecuteCommand` - Execute a SSH command on the remote server. * `NewSession` - Open a new SSH connection to the remote server. * `FileTransfer` - Transfer a file from Intersight connected device to the remote server. * `CloseSession` - Close the SSH connection to the remote server. type: string enum: - 'ExecuteCommand' - 'NewSession' - 'FileTransfer' - 'CloseSession' default: ExecuteCommand x-omitempty: true SshCommand: description: |- SSH command to execute on the remote server. $ref: '#/components/schemas/workflow.SshCmd' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SshConfiguration: description: |- Carries the SSH session details for opening a new connection. $ref: '#/components/schemas/workflow.SshConfig' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.StartTask: title: Workflow:Start Task description: |- A StartTask is the starting point for a workflow. There can only be one StartTask in a workflow. x-allOf-name: workflow.StartTask allOf: - # This 'workflow.StartTask' class inherits all properties from its parent class workflow.ControlTask. $ref: '#/components/schemas/workflow.ControlTask' - # The definition of all the properties specified in this 'workflow.StartTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.StartTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.StartTask' ObjectType: enum: - 'workflow.StartTask' NextTask: description: |- The name of the next task (Task names unique within workflow) to run. In a graph model, denotes an edge to another Task Node. type: string x-omitempty: true workflow.SubWorkflowTask: title: Workflow:Sub Workflow Task description: |- A SubWorkflowTask is used to include another workflow as a task within this workflow. x-allOf-name: workflow.SubWorkflowTask allOf: - # This 'workflow.SubWorkflowTask' class inherits all properties from its parent class workflow.AbstractWorkerTask. $ref: '#/components/schemas/workflow.AbstractWorkerTask' - # The definition of all the properties specified in this 'workflow.SubWorkflowTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.SubWorkflowTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.SubWorkflowTask' ObjectType: enum: - 'workflow.SubWorkflowTask' CatalogMoid: description: |- Specify the catalog moid that this task belongs. type: string x-omitempty: true Version: description: |- The workflow definition version to use as subworkflow. When no version is specified then the default version of the workflow at the time of creating or updating this workflow is used. type: integer format: int64 x-omitempty: true WorkflowDefinitionId: description: |- The resolved referenced workflow definition managed object. type: string readOnly: true x-omitempty: true WorkflowDefinitionName: description: |- The qualified name of workflow that should be executed as a task. type: string x-omitempty: true workflow.SuccessEndTask: title: Workflow:Success End Task description: |- A SuccessEndTask denotes the successful completion of a workflow. x-allOf-name: workflow.SuccessEndTask allOf: - # This 'workflow.SuccessEndTask' class inherits all properties from its parent class workflow.EndTask. $ref: '#/components/schemas/workflow.EndTask' workflow.TargetContext: title: Workflow:Target Context description: |- Target details like moid, type and name of the Intersight managed object. x-allOf-name: workflow.TargetContext allOf: - # This 'workflow.TargetContext' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.TargetContext' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.TargetContext', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.TargetContext' ObjectType: enum: - 'workflow.TargetContext' TargetMoid: description: |- Moid of the target Intersight managed object. type: string x-omitempty: true TargetName: description: |- Name of the target instance. type: string x-omitempty: true TargetType: description: |- Object type of the target Intersight managed object. type: string x-omitempty: true workflow.TargetDataType: title: Workflow:Target Data Type description: |- Data type to capture a target endpoint or device. x-allOf-name: workflow.TargetDataType allOf: - # This 'workflow.TargetDataType' class inherits all properties from its parent class workflow.BaseDataType. $ref: '#/components/schemas/workflow.BaseDataType' - # The definition of all the properties specified in this 'workflow.TargetDataType' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.TargetDataType', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.TargetDataType' ObjectType: enum: - 'workflow.TargetDataType' CustomDataTypeProperties: description: |- Reference to custom data type definition. $ref: '#/components/schemas/workflow.CustomDataProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true IsArray: description: |- When this property is true then an array of targets can be passed as input. type: boolean x-omitempty: true Max: description: |- Specify the maximum value of the array. type: integer format: int64 x-omitempty: true Min: description: |- Specify the minimum value of the array. type: integer format: int64 x-omitempty: true Properties: type: array items: description: |- Reference to target device or endpoint managed object. $ref: '#/components/schemas/workflow.TargetProperty' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.TargetProperty: title: Workflow:Target Property description: |- Capture all the properties for an input target endpoint or device. x-allOf-name: workflow.TargetProperty allOf: - # This 'workflow.TargetProperty' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.TargetProperty' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.TargetProperty', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.TargetProperty' ObjectType: enum: - 'workflow.TargetProperty' ConnectorAttribute: description: |- A singleton value which will contain the path to connector object from the selected object. type: string x-omitempty: true ConstraintAttributes: type: array items: description: |- A collection of properties that will be used to match a specific implemented task. Using these values, the workflow engine will try to pick an implemented task definition when multiple implementations exist. type: string x-omitempty: true DisplayAttributes: type: array items: description: |- List of properties from the Intersight object which can help to identify the object. Typically the set of identity constraints on the object can be listed here to help the user identity the managed object. type: string x-omitempty: true minItems: 1 Selector: description: |- Field to hold an Intersight API along with an optional filter to narrow down the search options for target device. type: string pattern: "^$|/api/v1/.*" x-omitempty: true SupportedObjects: type: array items: description: |- An explicit set of concrete objectTypes supported as part of this property entry. type: string x-omitempty: true workflow.TaskConstraints: title: Workflow:Task Constraints description: |- Captures the constraints for a task. Currently, it hold only targetDataType constraints such as Vendor, ObjectType that are properties of a target device. x-allOf-name: workflow.TaskConstraints allOf: - # This 'workflow.TaskConstraints' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.TaskConstraints' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.TaskConstraints', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.TaskConstraints' ObjectType: enum: - 'workflow.TaskConstraints' TargetDataType: description: |- List of property constraints that helps to narrow down task implementations based on target device input. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true workflow.TaskDefinition.Response: description: |- The response body of a HTTP GET request for the 'workflow.TaskDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.TaskDefinition' resources. x-one-of-name: workflow.TaskDefinition.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.TaskDefinition.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.TaskDefinition.Relationship: description: A relationship to the 'workflow.TaskDefinition' resource, or the expanded 'workflow.TaskDefinition' resource, or the 'null' value. x-one-of-name: workflow.TaskDefinition.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/workflow.TaskDefinition' workflow.TaskDefinition: title: Workflow:Task Definition description: |- Used to define a task which can be included within a workflow. Task definition conveys the intent that we want to achieve with the task. We can have a standalone task definition that is bound to a single implementation for that task, or we can define an TaskDefinition that will serve as the interface task definition which is linked to multiple implementation tasks. Each implemented TaskDefinition will be bound to its own implementation so we can achieve a case where single TaskDefinition has multiple implementations. x-allOf-name: workflow.TaskDefinition allOf: - # This 'workflow.TaskDefinition' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.TaskDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.TaskDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.TaskDefinition' ObjectType: enum: - 'workflow.TaskDefinition' DefaultVersion: description: |- When true this will be the task version that is used when a specific task definition version is not specified. The very first task definition created with a name will be set as the default version, after that user can explicitly set any version of the task definition as the default version. type: boolean x-omitempty: true Description: description: |- The task definition description to describe what this task will do when executed. type: string x-omitempty: true InternalProperties: description: |- Type to capture all the internal properties for the task definition. $ref: '#/components/schemas/workflow.InternalProperties' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Label: description: |- A user friendly short name to identify the task definition. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote ('), or an underscore (_). type: string pattern: "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]{1,92}$" x-omitempty: true LicenseEntitlement: description: |- License entitlement required to run this task. It is determined by license requirement of features. * `Base` - Base as a License type. It is default license type. * `Essential` - Essential as a License type. * `Standard` - Standard as a License type. * `Advantage` - Advantage as a License type. * `Premier` - Premier as a License type. type: string enum: - 'Base' - 'Essential' - 'Standard' - 'Advantage' - 'Premier' default: Base readOnly: true x-omitempty: true Name: description: |- The name of the task definition. The name should follow this convention Verb or Action is a required portion of the name and this must be part of the pre-approved verb list. Category is an optional field and this will refer to the broad category of the task referring to the type of resource or endpoint. If there is no specific category then use "Generic" if required. Vendor is an optional field and this will refer to the specific vendor this task applies to. If the task is generic and not tied to a vendor, then do not specify anything. Product is an optional field, this will contain the vendor product and model when desired. Noun or object is a required field and this will contain the noun or object on which the action is being performed. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), or an underscore (_). Examples SendEmail - This is a task in Generic category for sending email. NewStorageVolume - This is a vendor agnostic task under Storage device category for creating a new volume. type: string pattern: "^[a-zA-Z0-9_.:-]{1,64}$" x-createOnly: true x-omitempty: true Properties: description: |- Type to capture all the properties for the task definition. $ref: '#/components/schemas/workflow.Properties' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true SecurePropAccess: description: |- If set to true, the task requires access to secure properties and uses an encyption token associated with a workflow moid to encrypt or decrypt the secure properties. type: boolean x-omitempty: true Version: description: |- The version of the task definition so we can support multiple versions of a task definition. type: integer format: int64 minimum: 1 x-createOnly: true x-omitempty: true Catalog: # A Relationship to MO workflow.Catalog $ref: '#/components/schemas/workflow.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true ImplementedTasks: # A Relationship to MO workflow.TaskDefinition description: An array of relationships to workflowTaskDefinition resources. type: array items: $ref: '#/components/schemas/workflow.TaskDefinition.Relationship' nullable: true x-createOnly: true InterfaceTask: # A Relationship to MO workflow.TaskDefinition $ref: '#/components/schemas/workflow.TaskDefinition.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowTaskDefinition resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.TaskDefinition.List: title: List of 'workflow.TaskDefinition' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.TaskDefinition' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.TaskDefinition' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.TaskDefinition' nullable: true workflow.TaskInfo.Response: description: |- The response body of a HTTP GET request for the 'workflow.TaskInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.TaskInfo' resources. x-one-of-name: workflow.TaskInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.TaskInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.TaskInfo.Relationship: description: A relationship to the 'workflow.TaskInfo' resource, or the expanded 'workflow.TaskInfo' resource, or the 'null' value. x-one-of-name: workflow.TaskInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/workflow.TaskInfo' workflow.TaskInfo: title: Workflow:Task Info description: |- Task instance which represents the run time instance of a task within a workflow. x-allOf-name: workflow.TaskInfo allOf: - # This 'workflow.TaskInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.TaskInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.TaskInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.TaskInfo' ObjectType: enum: - 'workflow.TaskInfo' Description: description: |- The task description and this is the description that was added when the task was included into the workflow. type: string readOnly: true x-omitempty: true EndTime: description: |- The time stamp when the task reached a final state. type: string format: date-time readOnly: true x-omitempty: true FailureReason: description: |- Description of the reason why the task failed. type: string readOnly: true x-omitempty: true Input: description: |- The input data that was sent to the task at the start of execution. # Property is any value, it may be the null value, an object or array. nullable: true readOnly: true x-omitempty: true InstId: description: |- The instance ID of the task running in the workflow engine. type: string readOnly: true x-omitempty: true Internal: description: |- Denotes whether or not this is an internal task. Internal tasks will be hidden from the UI within a workflow. type: boolean readOnly: true x-omitempty: true Label: description: |- User friendly short label to describe this task instance in the workflow. type: string readOnly: true x-omitempty: true Message: type: array items: description: |- Collection of Task execution messages with severity. $ref: '#/components/schemas/workflow.Message' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Name: description: |- Task definition name which specifies the task type. type: string readOnly: true x-omitempty: true Output: description: |- The output data that was generated by this task. # Property is any value, it may be the null value, an object or array. nullable: true readOnly: true x-omitempty: true RefName: description: |- The task reference name to ensure its unique inside a workflow. type: string readOnly: true x-omitempty: true RetryCount: description: |- A counter for number of retries. type: integer format: int64 readOnly: true x-omitempty: true RunningInstId: description: |- The instance ID of the task that is currently being executed. When retrying a workflow with failed tasks, the task in workflow engine will have a new instance ID, but the task may still be in-progress. In this case, the task instId reflects the instance ID in the workflow engine, while runningInstId reflects the instance ID of the instance that is currently being executed. type: string readOnly: true x-omitempty: true StartTime: description: |- The time stamp when the task started execution. type: string format: date-time readOnly: true x-omitempty: true Status: description: |- The status of the task and this will specify if the task is running or has reached a final state. type: string x-omitempty: true TaskInstIdList: type: array items: description: |- The list keeps a list of retried task instances. $ref: '#/components/schemas/workflow.TaskRetryInfo' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true SubWorkflowInfo: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true TaskDefinition: # A Relationship to MO workflow.TaskDefinition $ref: '#/components/schemas/workflow.TaskDefinition.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowTaskDefinition resource. When the $expand query parameter is specified, the referenced resource is returned inline. WorkflowInfo: # A Relationship to MO workflow.WorkflowInfo $ref: '#/components/schemas/workflow.WorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true workflow.TaskInfo.List: title: List of 'workflow.TaskInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.TaskInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.TaskInfo' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.TaskInfo' nullable: true workflow.TaskRetryInfo: title: Workflow:Task Retry Info description: |- Keep track of task retry information using TaskRetryInfo. x-allOf-name: workflow.TaskRetryInfo allOf: - # This 'workflow.TaskRetryInfo' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.TaskRetryInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.TaskRetryInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.TaskRetryInfo' ObjectType: enum: - 'workflow.TaskRetryInfo' Status: description: |- Status of the retried task. type: string x-omitempty: true TaskInstId: description: |- Retry instance will get a unique instance id. type: string x-omitempty: true workflow.ValidationError: title: Workflow:Validation Error description: |- Used to show validation errors for the workflow or for the task within the workflow. x-allOf-name: workflow.ValidationError allOf: - # This 'workflow.ValidationError' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.ValidationError' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.ValidationError', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.ValidationError' ObjectType: enum: - 'workflow.ValidationError' ErrorLog: description: |- Description of the error. type: string readOnly: true x-omitempty: true Field: description: |- When populated this refers to the input or output field within the workflow or task. type: string readOnly: true x-omitempty: true TaskName: description: |- The task name on which the error is found, when empty the error applies to the top level workflow. type: string readOnly: true x-omitempty: true TransitionName: description: |- When populated this refers to the transition connection that has a problem. When this field has value OnSuccess it means the transition connection OnSuccess for the task has an issue. type: string readOnly: true x-omitempty: true workflow.ValidationInformation: title: Workflow:Validation Information description: |- Type used to capture all the validation information for the workflow definition. x-allOf-name: workflow.ValidationInformation allOf: - # This 'workflow.ValidationInformation' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.ValidationInformation' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.ValidationInformation', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.ValidationInformation' ObjectType: enum: - 'workflow.ValidationInformation' State: description: |- The current validation state of this workflow. The possible states are Valid, Invalid, NotValidated (default). * `NotValidated` - The state when workflow definition has not been validated. * `Valid` - The state when workflow definition is valid. * `Invalid` - The state when workflow definition is invalid. type: string enum: - 'NotValidated' - 'Valid' - 'Invalid' default: NotValidated readOnly: true x-omitempty: true ValidationError: type: array items: description: |- List of all workflow or task validation errors. The validation errors can be for worker task or for control tasks. $ref: '#/components/schemas/workflow.ValidationError' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true workflow.WaitTask: title: Workflow:Wait Task description: |- A WaitTask will remain in progress until marked success or failed by an external trigger. The timeout for wait task is 180 days, so a workflow can wait for task status update for upto 180 days. Currently the only supported means to update the task status is through an API that provides the status of the task runtime instance. Once the wait task status has been set the workflow will continue with the execution based on the task status. x-allOf-name: workflow.WaitTask allOf: - # This 'workflow.WaitTask' class inherits all properties from its parent class workflow.AbstractWorkerTask. $ref: '#/components/schemas/workflow.AbstractWorkerTask' - # The definition of all the properties specified in this 'workflow.WaitTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WaitTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WaitTask' ObjectType: enum: - 'workflow.WaitTask' Prompts: type: array items: description: |- List of prompts for this wait task. These prompts are useful to provide options to the user who is running a workflow that contains wait task on how to proceed after the wait task. $ref: '#/components/schemas/workflow.WaitTaskPrompt' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true workflow.WaitTaskPrompt: title: Workflow:Wait Task Prompt description: |- WaitTaskPrompt is used to create a customized prompts for wait control task. Wait task can be used in workflow for variety of reason, the prompts will help workflow designer to provide a customized set of prompts. x-allOf-name: workflow.WaitTaskPrompt allOf: - # This 'workflow.WaitTaskPrompt' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.WaitTaskPrompt' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WaitTaskPrompt', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WaitTaskPrompt' ObjectType: enum: - 'workflow.WaitTaskPrompt' Description: description: |- Description that give more details about what it means to pick this prompt option for the wait task. type: string x-omitempty: true Label: description: |- User friendly label for the prompt. This label will be shown to the user as one of available options for the wait task. type: string x-omitempty: true Name: description: |- Name for the wait prompt. type: string x-omitempty: true TaskStatus: description: |- Task status for the wait task when this prompt option is selected. * `Scheduled` - The enum represents the status when task is in scheduled state. * `InProgress` - The enum represents the status when task is in-progress state. * `NoOp` - The enum represents the status when task is a noop. * `Timeout` - The enum represents the status when task has timed out. * `Completed` - The enum represents the status when task has completed. * `Failed` - The enum represents the status when task has failed. type: string enum: - 'Scheduled' - 'InProgress' - 'NoOp' - 'Timeout' - 'Completed' - 'Failed' default: Scheduled x-omitempty: true workflow.WebApi: title: Web API description: |- This models a single Web API request within a batch of requests that get executed within a single workflow task. x-allOf-name: workflow.WebApi allOf: - # This 'workflow.WebApi' class inherits all properties from its parent class workflow.Api. $ref: '#/components/schemas/workflow.Api' - # The definition of all the properties specified in this 'workflow.WebApi' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WebApi', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WebApi' ObjectType: enum: - 'workflow.WebApi' EndpointRequestType: description: |- If the target type is Endpoint, this property determines whether the request is to be handled as internal request or external request by the device connector. * `Internal` - The endpoint API executed is an internal request handled by the device connector plugin. * `External` - The endpoint API request is passed through by the device connector. type: string enum: - 'Internal' - 'External' default: Internal x-omitempty: true Headers: description: |- Collection of key value pairs to set in the request header. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true Method: description: |- The HTTP method to be executed in the given URL (GET, POST, PUT, etc). If the value is not specified, GET will be used as default. type: string x-omitempty: true MoType: description: |- The type of the intersight object for which API request is to be made. The property is valid in case of Intersight API calls and the base url is automatically prepended based on the value. type: string x-omitempty: true Protocol: description: |- The accepted web protocol values are http and https. type: string x-omitempty: true TargetType: description: |- If the web API is to be executed in a remote device connected to the Intersight through device connector, 'Endpoint' is expected as the value whereas if the API is an Intersight API, 'Local' is expected as the value. * `Endpoint` - The API is executed in a remote device connected to the Intersightthrough its device connector. * `Local` - The API is an internal API to be executed within the Intersight. type: string enum: - 'Endpoint' - 'Local' default: Endpoint 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 workflow.WorkerTask: title: Workflow:Worker Task description: |- A WorkerTask is a simple task and the smallest granularity of work that can be defined as a task. x-allOf-name: workflow.WorkerTask allOf: - # This 'workflow.WorkerTask' class inherits all properties from its parent class workflow.AbstractWorkerTask. $ref: '#/components/schemas/workflow.AbstractWorkerTask' - # The definition of all the properties specified in this 'workflow.WorkerTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkerTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WorkerTask' ObjectType: enum: - 'workflow.WorkerTask' CatalogMoid: description: |- Specify the catalog moid that this task belongs. type: string x-omitempty: true TaskDefinitionId: description: |- The resolved referenced task definition managed object. type: string readOnly: true x-omitempty: true TaskDefinitionName: description: |- The qualified name of task that should be executed. type: string x-omitempty: true Version: description: |- The task definition version to use in this workflow. When no version is specified then the default version of the task at the time of creating or updating this workflow is used. type: integer format: int64 x-omitempty: true workflow.WorkflowCtx: title: Workflow:Workflow Ctx description: |- The workflow context contains initiator and target information along with workflow type and action information. x-allOf-name: workflow.WorkflowCtx allOf: - # This 'workflow.WorkflowCtx' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.WorkflowCtx' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkflowCtx', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WorkflowCtx' ObjectType: enum: - 'workflow.WorkflowCtx' InitiatorCtx: description: |- Details about initiator of the workflow. $ref: '#/components/schemas/workflow.InitiatorContext' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true TargetCtxList: type: array items: description: |- A list of targets context of the workflow. $ref: '#/components/schemas/workflow.TargetContext' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true WorkflowSubtype: description: |- The subtype of the workflow. type: string x-createOnly: true x-omitempty: true WorkflowType: description: |- Type of the workflow being started. This can be any string for client services to distinguish workflow by type. type: string x-createOnly: true x-omitempty: true workflow.WorkflowDefinition.Response: description: |- The response body of a HTTP GET request for the 'workflow.WorkflowDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.WorkflowDefinition' resources. x-one-of-name: workflow.WorkflowDefinition.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.WorkflowDefinition.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.WorkflowDefinition.Relationship: description: A relationship to the 'workflow.WorkflowDefinition' resource, or the expanded 'workflow.WorkflowDefinition' resource, or the 'null' value. x-one-of-name: workflow.WorkflowDefinition.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/workflow.WorkflowDefinition' workflow.WorkflowDefinition: title: Workflow Definition description: |- Workflow definition is a collection of tasks that are sequenced in a certain way using control tasks. The tasks in the workflow definition is represented as a directed acyclic graph where each node in the graph is a task and the edges in the graph are transitions from one task to another. x-allOf-name: workflow.WorkflowDefinition allOf: - # This 'workflow.WorkflowDefinition' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.WorkflowDefinition' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkflowDefinition', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WorkflowDefinition' ObjectType: enum: - 'workflow.WorkflowDefinition' DefaultVersion: description: |- When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version. type: boolean x-omitempty: true Description: description: |- The description for this workflow. type: string x-omitempty: true InputDefinition: type: array items: description: |- The schema expected for input parameters for this workflow. $ref: '#/components/schemas/workflow.BaseDataType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Label: description: |- A user friendly short name to identify the workflow. Label 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,92}$" x-omitempty: true LicenseEntitlement: description: |- License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks. * `Base` - Base as a License type. It is default license type. * `Essential` - Essential as a License type. * `Standard` - Standard as a License type. * `Advantage` - Advantage as a License type. * `Premier` - Premier as a License type. type: string enum: - 'Base' - 'Essential' - 'Standard' - 'Advantage' - 'Premier' default: Base readOnly: true x-omitempty: true MaxTaskCount: description: |- The maximum number of tasks that can be executed on this workflow. type: integer format: int64 readOnly: true x-omitempty: true Name: description: |- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_). type: string pattern: "^[a-zA-Z0-9_.-]{1,64}$" x-createOnly: true x-omitempty: true OutputDefinition: type: array items: description: |- The schema expected for output parameters for this workflow. $ref: '#/components/schemas/workflow.BaseDataType' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true OutputParameters: description: |- The output mappings for the workflow. The outputs for worflows will generally be task output variables that we want to export out at the end of the workflow. The format to specify the mapping is '${Source.output.JsonPath}'. 'Source' is the name of the task within the workflow. You can map any task output to a workflow output as long as the types are compatible. Following this is JSON path expression to extract JSON fragment from source's output. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true Properties: description: |- Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. $ref: '#/components/schemas/workflow.WorkflowProperties' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true Tasks: type: array items: description: |- The tasks contained inside of the workflow. $ref: '#/components/schemas/workflow.WorkflowTask' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true UiRenderingData: description: |- This will hold the data needed for workflow to be rendered in the user interface. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true ValidationInformation: description: |- The current validation state and associated information for this workflow. $ref: '#/components/schemas/workflow.ValidationInformation' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true Version: description: |- The version of the workflow to support multiple versions. type: integer format: int64 minimum: 1 x-createOnly: true x-omitempty: true Catalog: # A Relationship to MO workflow.Catalog $ref: '#/components/schemas/workflow.Catalog.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowCatalog resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.WorkflowDefinition.List: title: List of 'workflow.WorkflowDefinition' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.WorkflowDefinition' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.WorkflowDefinition' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.WorkflowDefinition' nullable: true workflow.WorkflowInfo.Response: description: |- The response body of a HTTP GET request for the 'workflow.WorkflowInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.WorkflowInfo' resources. x-one-of-name: workflow.WorkflowInfo.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.WorkflowInfo.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.WorkflowInfo.Relationship: description: A relationship to the 'workflow.WorkflowInfo' resource, or the expanded 'workflow.WorkflowInfo' resource, or the 'null' value. x-one-of-name: workflow.WorkflowInfo.Relationship oneOf: - type: 'null' - $ref: '#/components/schemas/mo.MoRef' - $ref: '#/components/schemas/workflow.WorkflowInfo' workflow.WorkflowInfo: title: Workflow:Workflow Info description: |- Contains information for a workflow execution which is a runtime instance of workflow. x-allOf-name: workflow.WorkflowInfo allOf: - # This 'workflow.WorkflowInfo' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.WorkflowInfo' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkflowInfo', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WorkflowInfo' ObjectType: enum: - 'workflow.WorkflowInfo' Action: description: |- The action of the workflow such as start, cancel, retry, pause. * `None` - No action is set, this is the default value for action field. * `Create` - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow. * `Start` - Start a new execution of the workflow. * `Pause` - Pause the workflow, this can only be issued on workflows that are in running state. * `Resume` - Resume the workflow which was previously paused through pause action on the workflow. * `Retry` - Retry the workflow that has previously reached a final state and has the retryable property set to true on the workflow. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted. The task name must be one of the tasks that completed or failed in the previous run, you cannot retry a workflow from a task which wasn't run in the previous iteration. * `RetryFailed` - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task. * `Cancel` - Cancel the workflow that is in running or waiting state. type: string enum: - 'None' - 'Create' - 'Start' - 'Pause' - 'Resume' - 'Retry' - 'RetryFailed' - 'Cancel' default: None x-omitempty: true CleanupTime: description: |- The time when the workflow info will be removed from database. type: string format: date-time readOnly: true x-omitempty: true EndTime: description: |- The time when the workflow reached a final state. type: string format: date-time readOnly: true x-omitempty: true FailedWorkflowCleanupDuration: description: |- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. type: integer format: int64 x-createOnly: true x-omitempty: true Input: description: |- All the given inputs for the workflow. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true InstId: description: |- A workflow instance Id which is the unique identified for the workflow execution. type: string readOnly: true x-omitempty: true Internal: description: |- Denotes if this workflow is internal and should be hidden from user view of running workflows. type: boolean x-createOnly: true x-omitempty: true LastAction: description: |- The last action that was issued on the workflow is saved in this field. * `None` - No action is set, this is the default value for action field. * `Create` - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow. * `Start` - Start a new execution of the workflow. * `Pause` - Pause the workflow, this can only be issued on workflows that are in running state. * `Resume` - Resume the workflow which was previously paused through pause action on the workflow. * `Retry` - Retry the workflow that has previously reached a final state and has the retryable property set to true on the workflow. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted. The task name must be one of the tasks that completed or failed in the previous run, you cannot retry a workflow from a task which wasn't run in the previous iteration. * `RetryFailed` - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task. * `Cancel` - Cancel the workflow that is in running or waiting state. type: string enum: - 'None' - 'Create' - 'Start' - 'Pause' - 'Resume' - 'Retry' - 'RetryFailed' - 'Cancel' default: None readOnly: true x-omitempty: true Message: type: array items: description: |- Collection of Workflow execution messages with severity. $ref: '#/components/schemas/workflow.Message' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true MetaVersion: description: |- Version of the workflow metadata for which this workflow execution was started. type: integer format: int64 x-createOnly: true x-omitempty: true Name: description: |- A name of the workflow execution instance. type: string pattern: "^[^:]{1,92}$" x-createOnly: true x-omitempty: true Output: description: |- All the generated outputs for the workflow. # Property is any value, it may be the null value, an object or array. nullable: true readOnly: true x-omitempty: true PauseReason: description: |- Denotes the reason workflow is in paused status. * `None` - Pause reason is none, which indicates there is no reason for the pause state. * `TaskWithWarning` - Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings. type: string enum: - 'None' - 'TaskWithWarning' default: None x-createOnly: true x-omitempty: true Progress: description: |- This field indicates percentage of workflow task execution. type: number format: float readOnly: true x-omitempty: true Properties: description: |- Type to capture all the properties for the workflow info passed on from workflow definition. $ref: '#/components/schemas/workflow.WorkflowInfoProperties' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. readOnly: true x-omitempty: true RetryFromTaskName: description: |- This field is applicable when Retry action is issued for a workflow which is in a final state. When this field is not specified then the workflow will retry from the start of the workflow. When this field is specified then the workflow will be retried from the specified task. The field should carry the task name which is the unique name of the task within the workflow. The task name must be one of the tasks that completed or failed in the previous run, you cannot retry a workflow from a task which wasn't run in the previous iteration. type: string x-omitempty: true Src: description: |- The source microservice name which is the owner for this workflow. type: string readOnly: true x-omitempty: true StartTime: description: |- The time when the workflow was started for execution. type: string format: date-time readOnly: true x-omitempty: true Status: description: |- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). type: string readOnly: true x-omitempty: true SuccessWorkflowCleanupDuration: description: |- The duration in hours after which the workflow info for successful workflow will be removed from database. type: integer format: int64 x-createOnly: true x-omitempty: true TraceId: description: |- The trace id to keep track of workflow execution. type: string readOnly: true x-omitempty: true Type: description: |- A type of the workflow (serverconfig, ansible_monitoring). type: string readOnly: true x-omitempty: true UserId: description: |- The user identifier which indicates the user that started this workflow. type: string readOnly: true x-omitempty: true WaitReason: description: |- Denotes the reason workflow is in waiting status. * `None` - Wait reason is none, which indicates there is no reason for the waiting state. * `GatherTasks` - Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks. * `Duplicate` - Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow. * `RateLimit` - Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold. * `WaitTask` - Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update. * `PendingRetryFailed` - Wait reason when the workflow is pending a RetryFailed action. type: string enum: - 'None' - 'GatherTasks' - 'Duplicate' - 'RateLimit' - 'WaitTask' - 'PendingRetryFailed' default: None x-createOnly: true x-omitempty: true WorkflowCtx: description: |- The workflow context which contains initiator and target information. $ref: '#/components/schemas/workflow.WorkflowCtx' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. x-omitempty: true WorkflowMetaType: description: |- The type of workflow meta. Derived from the workflow meta that is used to launch this workflow instance. * `SystemDefined` - System defined workflow definition. * `UserDefined` - User defined workflow definition. * `Dynamic` - Dynamically defined workflow definition. type: string enum: - 'SystemDefined' - 'UserDefined' - 'Dynamic' default: SystemDefined x-omitempty: true WorkflowTaskCount: description: |- Total number of workflow tasks in this workflow. type: integer format: int64 readOnly: true x-omitempty: true _0_SwitchProfile: # A Relationship to MO fabric.SwitchProfile $ref: '#/components/schemas/fabric.SwitchProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a fabricSwitchProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true _1_ClusterProfile: # A Relationship to MO hyperflex.ClusterProfile $ref: '#/components/schemas/hyperflex.ClusterProfile.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a hyperflexClusterProfile resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Account: # A Relationship to MO iam.Account deprecated: true $ref: '#/components/schemas/iam.Account.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamAccount resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true AssociatedObject: # A Relationship to MO mo.BaseMo $ref: '#/components/schemas/mo.BaseMo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a moBaseMo resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true Organization: # A Relationship to MO organization.Organization deprecated: true $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true ParentTaskInfo: # A Relationship to MO workflow.TaskInfo $ref: '#/components/schemas/workflow.TaskInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowTaskInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true PendingDynamicWorkflowInfo: # A Relationship to MO workflow.PendingDynamicWorkflowInfo $ref: '#/components/schemas/workflow.PendingDynamicWorkflowInfo.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowPendingDynamicWorkflowInfo resource. When the $expand query parameter is specified, the referenced resource is returned inline. readOnly: true Permission: # A Relationship to MO iam.Permission $ref: '#/components/schemas/iam.Permission.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a iamPermission resource. When the $expand query parameter is specified, the referenced resource is returned inline. TaskInfos: # A Relationship to MO workflow.TaskInfo description: An array of relationships to workflowTaskInfo resources. type: array items: $ref: '#/components/schemas/workflow.TaskInfo.Relationship' nullable: true readOnly: true WorkflowDefinition: # A Relationship to MO workflow.WorkflowDefinition $ref: '#/components/schemas/workflow.WorkflowDefinition.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a workflowWorkflowDefinition resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.WorkflowInfo.List: title: List of 'workflow.WorkflowInfo' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.WorkflowInfo' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.WorkflowInfo' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.WorkflowInfo' nullable: true workflow.WorkflowInfoProperties: title: Workflow:Workflow Info Properties description: |- Properties for a workflowInfo. x-allOf-name: workflow.WorkflowInfoProperties allOf: - # This 'workflow.WorkflowInfoProperties' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.WorkflowInfoProperties' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkflowInfoProperties', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WorkflowInfoProperties' ObjectType: enum: - 'workflow.WorkflowInfoProperties' Retryable: description: |- When true, this workflow can be retried if has not been modified for more than a period of 2 weeks. type: boolean x-createOnly: true x-omitempty: true workflow.WorkflowMeta.Response: description: |- The response body of a HTTP GET request for the 'workflow.WorkflowMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, the response schema is a summary of the tag usage. 1. When '$apply' is specified in the URL query, the response schema is dynamically-generated schema based on the $apply value. 1. When '$count' is specified in the URL query, the response is a simple object providing the count of the resources. 1. In all other cases, the response is a list of 'workflow.WorkflowMeta' resources. x-one-of-name: workflow.WorkflowMeta.Response oneOf: - $ref: '#/components/schemas/mo.DocumentCount' - $ref: '#/components/schemas/workflow.WorkflowMeta.List' - $ref: '#/components/schemas/mo.AggregateTransform' - $ref: '#/components/schemas/mo.TagSummary' discriminator: propertyName: ObjectType workflow.WorkflowMeta: title: Workflow:Workflow Meta description: |- Contains a workflow definition which is a sequence of tasks to execute. x-allOf-name: workflow.WorkflowMeta allOf: - # This 'workflow.WorkflowMeta' class inherits all properties from its parent class mo.BaseMo. $ref: '#/components/schemas/mo.BaseMo' - # The definition of all the properties specified in this 'workflow.WorkflowMeta' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkflowMeta', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WorkflowMeta' ObjectType: enum: - 'workflow.WorkflowMeta' Description: description: |- The description for the workflow. type: string x-omitempty: true InputParameters: type: array items: description: |- The workflow input parameters. type: string x-omitempty: true Name: description: |- The name given to the workflow. type: string pattern: "^$|^[^:]{1,92}$" x-omitempty: true OutputParameters: description: |- The workflow output parameters. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true Retryable: description: |- When true, this workflow can be retried for 2 weeks since the last modification of the workflow. type: boolean x-omitempty: true SchemaVersion: description: |- The Conductor schema version that decides what attribute can be supported. type: integer format: int64 x-omitempty: true Src: description: |- The src is workflow owner service. type: string x-omitempty: true Tasks: description: |- The tasks contained inside of the workflow. # Property is any value, it may be the null value, an object or array. nullable: true x-omitempty: true Type: description: |- The type of workflow definition. * `SystemDefined` - System defined workflow definition. * `UserDefined` - User defined workflow definition. * `Dynamic` - Dynamically defined workflow definition. type: string enum: - 'SystemDefined' - 'UserDefined' - 'Dynamic' default: SystemDefined x-omitempty: true Version: description: |- The version for the workflow so we can support multiple versions for the same workflow name. type: integer format: int64 x-omitempty: true WaitOnDuplicate: description: |- Parameter decides if workflows will wait for a duplicate to finish before starting a new one. type: boolean x-omitempty: true Organization: # A Relationship to MO organization.Organization $ref: '#/components/schemas/organization.Organization.Relationship' # The attributes below are for documentation purpose only. They are not used by OpenAPI tooling. description: |- A reference to a organizationOrganization resource. When the $expand query parameter is specified, the referenced resource is returned inline. x-createOnly: true workflow.WorkflowMeta.List: title: List of 'workflow.WorkflowMeta' resources description: |- This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier. allOf: - $ref: '#/components/schemas/mo.BaseResponse' - type: object properties: Count: description: |- The total number of 'workflow.WorkflowMeta' resources matching the request, accross all pages. The 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter. type: integer format: int32 Results: description: The array of 'workflow.WorkflowMeta' resources matching the request. type: array items: $ref: '#/components/schemas/workflow.WorkflowMeta' nullable: true workflow.WorkflowProperties: title: Workflow:Workflow Properties description: |- Properties for a workflow definition. x-allOf-name: workflow.WorkflowProperties allOf: - # This 'workflow.WorkflowProperties' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.WorkflowProperties' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkflowProperties', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'workflow.WorkflowProperties' ObjectType: enum: - 'workflow.WorkflowProperties' ExternalMeta: description: |- When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities. type: boolean x-createOnly: true x-omitempty: true Retryable: description: |- When true, this workflow can be retried if has not been modified for more than a period of 2 weeks. type: boolean x-omitempty: true SupportStatus: description: |- Supported status of the definition. * `Supported` - The definition is a supported version and there will be no changes to the mandatory inputs or outputs. * `Beta` - The definition is a Beta version and this version can under go changes until the version is marked supported. * `Deprecated` - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added. type: string enum: - 'Supported' - 'Beta' - 'Deprecated' default: Supported x-omitempty: true workflow.WorkflowTask: title: Workflow:Workflow Task description: |- Task instance within the workflow to be executed. x-allOf-name: workflow.WorkflowTask allOf: - # This 'workflow.WorkflowTask' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'workflow.WorkflowTask' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'workflow.WorkflowTask', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: Description: description: |- The description of this task instance in the workflow. type: string x-omitempty: true Label: description: |- A user defined label identifier of the workflow task used for UI display. type: string x-omitempty: true Name: description: |- The name of the task within the workflow and it must be unique among all WorkflowTasks within a workflow definition. This name serves as the internal unique identifier for the task and is used to pick input and output parameters to feed into other tasks. type: string pattern: "^[a-zA-Z0-9_:-]{1,64}$" x-omitempty: true workflow.XmlApi: title: XML API description: |- This models a single XML API request that can be sent to any Cisco UCS devices that support Cisco UCS XML API interface. x-allOf-name: workflow.XmlApi allOf: - # This 'workflow.XmlApi' class inherits all properties from its parent class workflow.Api. $ref: '#/components/schemas/workflow.Api' x509.Certificate: title: X509:Certificate description: |- The representation of an X.509 certificate. x-allOf-name: x509.Certificate allOf: - # This 'x509.Certificate' class inherits all properties from its parent class mo.BaseComplexType. $ref: '#/components/schemas/mo.BaseComplexType' - # The definition of all the properties specified in this 'x509.Certificate' class, excluding properties from the parent class. type: object description: Definition of the list of properties defined in 'x509.Certificate', excluding properties defined in parent classes. required: - ClassId - ObjectType properties: ClassId: enum: - 'x509.Certificate' ObjectType: enum: - 'x509.Certificate' Issuer: description: |- The X.509 distinguished name of the issuer of this certificate. $ref: '#/components/schemas/pkix.DistinguishedName' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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' # All attributes below are for documentation purpose only. They are ignored by the OpenAPI tools. 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 MO and potentially properties of Ancestor MOs. Displaynames are intended as a way to provide a normalized user appropriate name for an MO, especially for MOs which do not have a 'Name' property, which is the case for much of the inventory discovered from managed targets. There are a limited number of keys, currently 'short' and 'hierarchical'. The value is an array and clients should 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. The language is determined from the "Accept-Language" request-header. The Accept-Language request-header restricts the set of natural languages that are preferred as a response to the request. See RFC 2616 for more details. Codes: 1. **InternalServerError** An internal error occurred. 1. **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. 1. **InvalidUrl** The HTTP request contains an invalid URL. 1. **InvalidRequest** The HTTP request contains an invalid or malformed message body. 1. **NotSupported** The request is not supported for the specified REST resource. 1. **NotImplemented** This API path is experimental and not implemented yet. 1. **NotFound** The requested REST resource does not exist. 1. **AuthenticationFailure** The request lacks valid authentication credentials. 1. **UnauthorizedOperation** The client is not authorized to perform the operation, such as when the user has insufficient privileges. 1. **ValidationConflict** The request contains conflicting attributes, such as two mutually exclusive attribute values. 1. **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, and the 'CreateTime' and 'ModTime' properties, which are explicitly specified in the $select query. The 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. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). required: false schema: type: string default: '' examples: # Examples that use date operators and functions 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. The now() function is resolved to the current time in the Intersight service when the query is processed. 'PT72H' is a string value that represents 72 hours. See https://intersight.com/apidocs for more details about how to construct a duration. The "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: # Sort date properties 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 are processed in order with the output from a transformation being used as input for the subsequent transformation. The "$apply" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are "aggregate" and "groupby". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. 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, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A 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. A URI with an "at" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type 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 the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. required: false schema: type: string 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 a resource not known to exist, guaranteeing that another resource creation didn't happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered 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. The client SHOULD NOT repeat the request without modifications. For example, the request may contain an incorrect JSON syntax, or the request fails validation checks. The 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. If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. The 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. The HTTP body may contain a document that provides more details about the error. For 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 as specified in https://datatracker.ietf.org/doc/draft-cavage-http-signatures/. See [Intersight API and SDK documentation](https://intersight.com/apidocs) for details about how to configure the HTTP signature scheme. You must include the following fields in the signed headers. 1. '(request-target)' 1. '(created)' 1. 'Host' 1. 'Date' 1. 'Digest' In addition, it is recommended that you include at least the following headers. 1. '(expires)' 1. 'Content-Type' * The '(created)' header expresses when the signature was created. The value must be a Unix timestamp integer value. Subsecond precision is not supported. * The ('expires') header is optional and expresses when the signature ceases to be valid. The value must be a Unix timestamp integer value. Subsecond precision is allowed using decimal notation. It is recommended to set the value of the '(expire)' header to '(created)' plus thirty minutes, i.e. the signature is valid for thirty minutes. * The 'Digest' header value must be a cryptographic digest of the HTTP request body, as specified in RFC 3230. * The 'Authorization' header must include the computed signature of the HTTP request. The host machine where the API client is running must be synchronized with Internet time (i.e. NIST time). oAuth2: type: oauth2 description: |- The client uses the OAuth2 security scheme. To use OAuth2, a client application must be registered by creating a iam.AppRegistration resource. The user who creates the iam.AppRegistration resource can specify a list of OAuth2 scopes. These iam.AppRegistration scopes restricts which subset of scopes a registered client can obtain. Supported OAuth2 flows are: **Authorization Code** In the authorization code flow, the client sends a list of requested scopes to the authorization URL (/iam/app-authorize). The scope in the authorization request must be one of the scopes that have been configured in the corresponding iam.AppRegistration resource. **Client Credentials** In the client credentials flow, the scope is selected when the AppRegistration is 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: # Scopes derived from iam.Permission PERMISSION.Account Administrator: | As an Account administrator, you have complete access to all services and resources in Intersight. You can perform all administrative and management tasks, including claim and manage devices, create and deploy Server and HyperFlex Cluster profiles, upgrade firmware, perform server actions, cross launch devices, add and manage users and groups, configure Identity providers and more. PERMISSION.Device Administrator: | As a Device Administrator, you can claim and unclaim a device in Intersight, view the device details, license status, a list of all the claimed devices, and generate API keys. You cannot perform any other management or administrative task in this role. PERMISSION.Device Technician: | As a Device Technician you can claim a device, view the device details, license status, a list of the claimed devices, and generate API keys. You cannot perform any other management or administrative task in this role. PERMISSION.HyperFlex Cluster Administrator: | As a HyperFlex Cluster Administrator, you can create, edit, deploy, and manage HyperFlex Clusters, view all the cluster dashboard widgets, view cluster details, create HyperFlex policies and profiles, and launch HyperFlex Connect.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. PERMISSION.Read-Only: | As a Read-Only user, you can view the dashboard, table views of the managed devices, change user preferences, and generate API keys. You cannot claim a device, add or remove a user, configure Identity providers or perform any server actions. PERMISSION.Server Administrator: | As a Server Administrator, you can view and manage UCS Servers and Fabric Interconnects, view all the server and Fabric Interconnect dashboard widgets, perform server actions, view server details, launch management interfaces and the CLI, create and deploy server 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. PERMISSION.Storage Administrator: | As a Storage Administrator, a user can view and manage Storage devices, view and execute workflows and view all the storage dashboard widgets. This privilege 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. PERMISSION.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. PERMISSION.User Access Administrator: | As a User Access Administrator, you can add and manage Users and Groups in Intersight, view account details and audit logs, manage the IdPs, roles, sessions and API keys for non Account Administrator users. However, you cannot claim a device or perform any management tasks in Intersight. You cannot add or manage a user with Account Administrator role. PERMISSION.Virtualization Administrator: | As a Virtualization Administrator, a user can view and manage hypervisor resources, view and execute workflows. This privilege 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. PERMISSION.Workflow Designer: | As a Workflow Designer, you can define workflow definitions and custom data types, view workflow definitions, task definitions and custom data types, execute workflows and view workflow executions. clientCredentials: tokenUrl: /iam/token scopes: # Scopes derived from iam.Permission PERMISSION.Account Administrator: | As an Account administrator, you have complete access to all services and resources in Intersight. You can perform all administrative and management tasks, including claim and manage devices, create and deploy Server and HyperFlex Cluster profiles, upgrade firmware, perform server actions, cross launch devices, add and manage users and groups, configure Identity providers and more. PERMISSION.Device Administrator: | As a Device Administrator, you can claim and unclaim a device in Intersight, view the device details, license status, a list of all the claimed devices, and generate API keys. You cannot perform any other management or administrative task in this role. PERMISSION.Device Technician: | As a Device Technician you can claim a device, view the device details, license status, a list of the claimed devices, and generate API keys. You cannot perform any other management or administrative task in this role. PERMISSION.HyperFlex Cluster Administrator: | As a HyperFlex Cluster Administrator, you can create, edit, deploy, and manage HyperFlex Clusters, view all the cluster dashboard widgets, view cluster details, create HyperFlex policies and profiles, and launch HyperFlex Connect.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. PERMISSION.Read-Only: | As a Read-Only user, you can view the dashboard, table views of the managed devices, change user preferences, and generate API keys. You cannot claim a device, add or remove a user, configure Identity providers or perform any server actions. PERMISSION.Server Administrator: | As a Server Administrator, you can view and manage UCS Servers and Fabric Interconnects, view all the server and Fabric Interconnect dashboard widgets, perform server actions, view server details, launch management interfaces and the CLI, create and deploy server 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. PERMISSION.Storage Administrator: | As a Storage Administrator, a user can view and manage Storage devices, view and execute workflows and view all the storage dashboard widgets. This privilege 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. PERMISSION.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. PERMISSION.User Access Administrator: | As a User Access Administrator, you can add and manage Users and Groups in Intersight, view account details and audit logs, manage the IdPs, roles, sessions and API keys for non Account Administrator users. However, you cannot claim a device or perform any management tasks in Intersight. You cannot add or manage a user with Account Administrator role. PERMISSION.Virtualization Administrator: | As a Virtualization Administrator, a user can view and manage hypervisor resources, view and execute workflows. This privilege 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. PERMISSION.Workflow Designer: | As a Workflow Designer, you can define workflow definitions and custom data types, view workflow definitions, task definitions and custom data types, execute workflows and view workflow executions. # Scopes derived from iam.PrivilegeSet PRIVSET.Account Administrator: | A set of privileges that provides complete access to all services and resources in Intersight. PRIVSET.Authentication: | A set of privileges that allows to manage authentication and identity management for the user. PRIVSET.Claim Devices: | Claim devices. PRIVSET.Delete Devices: | Delete Devices. PRIVSET.Devices: | A set of privileges that allows the access to manage devices e.g. view device details, claim and delete devices. PRIVSET.Execute Workflows: | A set of privileges that allow the users to execute workflows and manage running workflows in IO. PRIVSET.Fabric Interconnects: | A set of privileges that allows to perform operations related to Fabric Interconnect e.g. view fabric interconnect summary or detailed information about fabric connect. Fabric Interconnect privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges related to Fabric Interconnect. PRIVSET.HyperFlex Cluster: | A set of privileges that allows the access to manage HyperFlex clusters. PRIVSET.HyperFlex Cluster Profiles: | A set of privileges that allows to manage HyperFlex policies and profiles. PRIVSET.Hypervisors: | A set of privileges that allows the access to detailed hypervisor information and to perform hypervisor related actions. Hypervisors privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges related to hypervisors. PRIVSET.Launch Endpoint Management Interfaces: | Launch Endpoint Management Interfaces. PRIVSET.Manage API Keys: | Manage API Keys. PRIVSET.Manage Access and Permissions: | Manage access control rules and permissions. PRIVSET.Manage Auth Tokens: | Manage Authentication and Authorization Tokens. PRIVSET.Manage Exports: | A set of privileges that allow the users to export Intersight managed objects. PRIVSET.Manage Fabric Interconnects: | Manage Fabric Interconnects. PRIVSET.Manage HyperFlex Cluster Profiles: | Manage HyperFlex Cluster Profiles. PRIVSET.Manage HyperFlex Clusters: | Manage HyperFlex Clusters. PRIVSET.Manage Hypervisors: | A set of privileges that allow the users to execute workflows related to hypervisor and virtual machines management. PRIVSET.Manage Identity Providers: | Manage Single Sign On identity providers. PRIVSET.Manage Imports: | A set of privileges that allow the users to import Intersight managed objects. PRIVSET.Manage Organizations: | A set of privileges that allows the access to manage Organizations. PRIVSET.Manage Server Profiles: | Manage server profiles. PRIVSET.Manage Servers: | Manage Servers. PRIVSET.Manage Sessions: | Manage user login sessions. PRIVSET.Manage Storage Arrays: | A set of privileges that allow the user to execute workflows related to storage arrays. PRIVSET.Manage Switch Profiles: | Manage Switch Profiles. PRIVSET.Manage Telemetry: | Manage Telemetry allows [READ of broker information](http://druid.io/docs/latest/operations/api-reference.html#broker). PRIVSET.Manage Workflow Definitions: | A set of privileges that allow the users to manage workflow and custom data type definitions. PRIVSET.Organizations: | A set of privileges that allows the access to manage Organizations. PRIVSET.Read-Only: | A set of privileges that provides read-only access to services and resources in Intersight. PRIVSET.Server Administrator: | As a Server Administrator, you can view and manage UCS Servers and Fabric Interconnects, view all the server and Fabric Interconnect dashboard widgets, perform server actions, view server details, launch management interfaces and the CLI, create and deploy server policies and profiles, and manage API keys. PRIVSET.Server Profiles: | A set of privileges that allows to manage server policies and server profiles. Server Policy Management privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges related to server policy management. PRIVSET.Servers: | A set of privileges that allows the access to detailed server information and to perform server related actions. Servers privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges related to servers. PRIVSET.Storage Arrays: | A set of privileges that allows the access to detailed storage array information and to perform storage array related actions. Storage Arrays privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges related to storage arrays. PRIVSET.Switch Profiles: | A set of privileges that allows to manage Switch Profiles and Network configuration policies. PRIVSET.Telemetry: | A set of privileges that allows to access to telemetry data. Telemetry privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges related to Telemetry. View Telemetry allows [POST of a Druid query](http://druid.io/docs/latest/querying/querying). Manage Telemetry allows [READ of broker information](http://druid.io/docs/latest/operations/api-reference.html#broker). PRIVSET.View Audit Logs: | View audit records. PRIVSET.View Devices: | A set of privileges that allows read access to devices. PRIVSET.View Exports: | A set of privileges that allow users to view export operations. PRIVSET.View Fabric Interconnects: | View Fabric Interconnects. PRIVSET.View HyperFlex Cluster Profiles: | View HyperFlex Cluster Profiles. PRIVSET.View HyperFlex Clusters: | View HyperFlex Clusters. PRIVSET.View Hypervisors: | A set of privileges that allow users to view hypervisor and virtual machines related inventory and dashboards. PRIVSET.View Imports: | A set of privileges that allow users to view the import operations. PRIVSET.View Licensing Status: | View Licensing Status PRIVSET.View Organizations: | View Organizations PRIVSET.View Server Profiles: | View server profiles. PRIVSET.View Servers: | View Servers. PRIVSET.View Storage Arrays: | A set of privileges that allow the users to view storage related inventory and dashboards. PRIVSET.View Switch Profiles: | View Switch Profiles. PRIVSET.View Telemetry: | allows [POST of a Druid query](http://druid.io/docs/latest/querying/querying). PRIVSET.View Workflow Definitions: | A set of privileges that allow the users to view the workflow, task and custom data type definitions. PRIVSET.View Workflow Executions: | A set of privileges that allow the users to view the running instances of the workflows. # Scopes derived from iam.Privilege READ.aaa.AuditRecord: Read a 'aaa.AuditRecord' 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. 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. READ.adapter.HostFcInterface: Read a 'adapter.HostFcInterface' resource. READ.adapter.HostIscsiInterface: Read a 'adapter.HostIscsiInterface' resource. READ.adapter.Unit: Read a 'adapter.Unit' 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. 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.CertificateSetting: Read a 'appliance.CertificateSetting' resource. UPDATE.appliance.CertificateSetting: Update a 'appliance.CertificateSetting' 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. CREATE.appliance.DeviceClaim: Create a 'appliance.DeviceClaim' resource. READ.appliance.DeviceClaim: Read a 'appliance.DeviceClaim' 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. READ.appliance.ImageBundle: Read a 'appliance.ImageBundle' resource. READ.appliance.NodeInfo: Read a 'appliance.NodeInfo' resource. READ.appliance.ReleaseNote: Read a 'appliance.ReleaseNote' 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.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.asset.ClusterMember: Read a 'asset.ClusterMember' 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. DELETE.asset.DeviceRegistration: Deletes the resource representing the device connector. All associated REST resources will be deleted. In particular, inventory and operational data associated with this device will be deleted. 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.ManagedDevice: Create a 'asset.ManagedDevice' resource. DELETE.asset.ManagedDevice: Delete a 'asset.ManagedDevice' resource. READ.asset.ManagedDevice: Read a 'asset.ManagedDevice' resource. UPDATE.asset.ManagedDevice: Update a 'asset.ManagedDevice' 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. 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.Unit: Read a 'bios.Unit' resource. UPDATE.bios.Unit: Update a 'bios.Unit' resource. READ.boot.DeviceBootMode: Read a 'boot.DeviceBootMode' resource. UPDATE.boot.DeviceBootMode: Update a 'boot.DeviceBootMode' 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. CREATE.capability.AdapterUnitDescriptor: Create a 'capability.AdapterUnitDescriptor' resource. DELETE.capability.AdapterUnitDescriptor: Delete a 'capability.AdapterUnitDescriptor' resource. READ.capability.AdapterUnitDescriptor: Read a 'capability.AdapterUnitDescriptor' resource. UPDATE.capability.AdapterUnitDescriptor: Update a 'capability.AdapterUnitDescriptor' resource. READ.capability.Catalog: Read a 'capability.Catalog' resource. UPDATE.capability.Catalog: Update a 'capability.Catalog' resource. CREATE.capability.ChassisDescriptor: Create a 'capability.ChassisDescriptor' resource. DELETE.capability.ChassisDescriptor: Delete a 'capability.ChassisDescriptor' resource. READ.capability.ChassisDescriptor: Read a 'capability.ChassisDescriptor' resource. UPDATE.capability.ChassisDescriptor: Update a 'capability.ChassisDescriptor' resource. CREATE.capability.ChassisManufacturingDef: Create a 'capability.ChassisManufacturingDef' resource. DELETE.capability.ChassisManufacturingDef: Delete a 'capability.ChassisManufacturingDef' resource. READ.capability.ChassisManufacturingDef: Read a 'capability.ChassisManufacturingDef' resource. UPDATE.capability.ChassisManufacturingDef: Update a 'capability.ChassisManufacturingDef' resource. CREATE.capability.EquipmentPhysicalDef: Create a 'capability.EquipmentPhysicalDef' resource. DELETE.capability.EquipmentPhysicalDef: Delete a 'capability.EquipmentPhysicalDef' resource. READ.capability.EquipmentPhysicalDef: Read a 'capability.EquipmentPhysicalDef' resource. UPDATE.capability.EquipmentPhysicalDef: Update a 'capability.EquipmentPhysicalDef' resource. CREATE.capability.EquipmentSlotArray: Create a 'capability.EquipmentSlotArray' resource. DELETE.capability.EquipmentSlotArray: Delete a 'capability.EquipmentSlotArray' resource. READ.capability.EquipmentSlotArray: Read a 'capability.EquipmentSlotArray' resource. UPDATE.capability.EquipmentSlotArray: Update a 'capability.EquipmentSlotArray' resource. CREATE.capability.FanModuleDescriptor: Create a 'capability.FanModuleDescriptor' resource. DELETE.capability.FanModuleDescriptor: Delete a 'capability.FanModuleDescriptor' resource. READ.capability.FanModuleDescriptor: Read a 'capability.FanModuleDescriptor' resource. UPDATE.capability.FanModuleDescriptor: Update a 'capability.FanModuleDescriptor' resource. CREATE.capability.FanModuleManufacturingDef: Create a 'capability.FanModuleManufacturingDef' resource. DELETE.capability.FanModuleManufacturingDef: Delete a 'capability.FanModuleManufacturingDef' resource. READ.capability.FanModuleManufacturingDef: Read a 'capability.FanModuleManufacturingDef' resource. UPDATE.capability.FanModuleManufacturingDef: Update a 'capability.FanModuleManufacturingDef' resource. CREATE.capability.IoCardCapabilityDef: Create a 'capability.IoCardCapabilityDef' resource. DELETE.capability.IoCardCapabilityDef: Delete a 'capability.IoCardCapabilityDef' resource. READ.capability.IoCardCapabilityDef: Read a 'capability.IoCardCapabilityDef' resource. UPDATE.capability.IoCardCapabilityDef: Update a 'capability.IoCardCapabilityDef' resource. CREATE.capability.IoCardDescriptor: Create a 'capability.IoCardDescriptor' resource. DELETE.capability.IoCardDescriptor: Delete a 'capability.IoCardDescriptor' resource. READ.capability.IoCardDescriptor: Read a 'capability.IoCardDescriptor' resource. UPDATE.capability.IoCardDescriptor: Update a 'capability.IoCardDescriptor' resource. CREATE.capability.IoCardManufacturingDef: Create a 'capability.IoCardManufacturingDef' resource. DELETE.capability.IoCardManufacturingDef: Delete a 'capability.IoCardManufacturingDef' resource. READ.capability.IoCardManufacturingDef: Read a 'capability.IoCardManufacturingDef' resource. UPDATE.capability.IoCardManufacturingDef: Update a 'capability.IoCardManufacturingDef' resource. CREATE.capability.PortGroupAggregationDef: Create a 'capability.PortGroupAggregationDef' resource. DELETE.capability.PortGroupAggregationDef: Delete a 'capability.PortGroupAggregationDef' resource. READ.capability.PortGroupAggregationDef: Read a 'capability.PortGroupAggregationDef' resource. UPDATE.capability.PortGroupAggregationDef: Update a 'capability.PortGroupAggregationDef' resource. CREATE.capability.PsuDescriptor: Create a 'capability.PsuDescriptor' resource. DELETE.capability.PsuDescriptor: Delete a 'capability.PsuDescriptor' resource. READ.capability.PsuDescriptor: Read a 'capability.PsuDescriptor' resource. UPDATE.capability.PsuDescriptor: Update a 'capability.PsuDescriptor' resource. CREATE.capability.PsuManufacturingDef: Create a 'capability.PsuManufacturingDef' resource. DELETE.capability.PsuManufacturingDef: Delete a 'capability.PsuManufacturingDef' resource. READ.capability.PsuManufacturingDef: Read a 'capability.PsuManufacturingDef' resource. UPDATE.capability.PsuManufacturingDef: Update a 'capability.PsuManufacturingDef' resource. CREATE.capability.Section: Create a 'capability.Section' resource. READ.capability.Section: Read a 'capability.Section' resource. UPDATE.capability.Section: Update a 'capability.Section' resource. CREATE.capability.SiocModuleCapabilityDef: Create a 'capability.SiocModuleCapabilityDef' resource. DELETE.capability.SiocModuleCapabilityDef: Delete a 'capability.SiocModuleCapabilityDef' resource. READ.capability.SiocModuleCapabilityDef: Read a 'capability.SiocModuleCapabilityDef' resource. UPDATE.capability.SiocModuleCapabilityDef: Update a 'capability.SiocModuleCapabilityDef' resource. CREATE.capability.SiocModuleDescriptor: Create a 'capability.SiocModuleDescriptor' resource. DELETE.capability.SiocModuleDescriptor: Delete a 'capability.SiocModuleDescriptor' resource. READ.capability.SiocModuleDescriptor: Read a 'capability.SiocModuleDescriptor' resource. UPDATE.capability.SiocModuleDescriptor: Update a 'capability.SiocModuleDescriptor' resource. CREATE.capability.SiocModuleManufacturingDef: Create a 'capability.SiocModuleManufacturingDef' resource. DELETE.capability.SiocModuleManufacturingDef: Delete a 'capability.SiocModuleManufacturingDef' resource. READ.capability.SiocModuleManufacturingDef: Read a 'capability.SiocModuleManufacturingDef' resource. UPDATE.capability.SiocModuleManufacturingDef: Update a 'capability.SiocModuleManufacturingDef' resource. CREATE.capability.SwitchCapability: Create a 'capability.SwitchCapability' resource. DELETE.capability.SwitchCapability: Delete a 'capability.SwitchCapability' resource. READ.capability.SwitchCapability: Read a 'capability.SwitchCapability' resource. UPDATE.capability.SwitchCapability: Update a 'capability.SwitchCapability' resource. CREATE.capability.SwitchDescriptor: Create a 'capability.SwitchDescriptor' resource. DELETE.capability.SwitchDescriptor: Delete a 'capability.SwitchDescriptor' resource. READ.capability.SwitchDescriptor: Read a 'capability.SwitchDescriptor' resource. UPDATE.capability.SwitchDescriptor: Update a 'capability.SwitchDescriptor' resource. CREATE.capability.SwitchManufacturingDef: Create a 'capability.SwitchManufacturingDef' resource. DELETE.capability.SwitchManufacturingDef: Delete a 'capability.SwitchManufacturingDef' resource. READ.capability.SwitchManufacturingDef: Read a 'capability.SwitchManufacturingDef' resource. UPDATE.capability.SwitchManufacturingDef: Update a 'capability.SwitchManufacturingDef' resource. READ.compute.Blade: Read a 'compute.Blade' resource. UPDATE.compute.Blade: Update a 'compute.Blade' resource. DELETE.compute.BladeIdentity: Delete a 'compute.BladeIdentity' 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.PhysicalSummary: Read a 'compute.PhysicalSummary' 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. READ.compute.ServerSetting: Read a 'compute.ServerSetting' resource. UPDATE.compute.ServerSetting: Update a 'compute.ServerSetting' 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.HclStatus: Read a 'cond.HclStatus' resource. READ.cond.HclStatusDetail: Read a 'cond.HclStatusDetail' resource. READ.cond.HclStatusJob: Read a 'cond.HclStatusJob' resource. READ.config.ExportedItem: Read a 'config.ExportedItem' resource. CREATE.config.Exporter: Create a 'config.Exporter' resource. DELETE.config.Exporter: Delete a 'config.Exporter' resource. READ.config.Exporter: Read a 'config.Exporter' resource. READ.config.ImportedItem: Read a 'config.ImportedItem' resource. CREATE.config.Importer: Create a 'config.Importer' resource. DELETE.config.Importer: Delete a 'config.Importer' resource. READ.config.Importer: Read a 'config.Importer' 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. 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.equipment.Chassis: Read a 'equipment.Chassis' resource. UPDATE.equipment.Chassis: Update a 'equipment.Chassis' resource. READ.equipment.ChassisIdentity: Read a 'equipment.ChassisIdentity' resource. UPDATE.equipment.ChassisIdentity: Update a 'equipment.ChassisIdentity' resource. READ.equipment.DeviceSummary: Read a 'equipment.DeviceSummary' resource. READ.equipment.Fan: Read a 'equipment.Fan' resource. UPDATE.equipment.Fan: Update a 'equipment.Fan' 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.IdentitySummary: Read a 'equipment.IdentitySummary' 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.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.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.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.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. READ.fabric.ConfigChangeDetail: Read a 'fabric.ConfigChangeDetail' resource. READ.fabric.ConfigResult: Read a 'fabric.ConfigResult' resource. READ.fabric.ConfigResultEntry: Read a 'fabric.ConfigResultEntry' 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. 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. 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.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.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. 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.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.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.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.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. 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.fault.Instance: Read a 'fault.Instance' resource. UPDATE.fault.Instance: Update a 'fault.Instance' 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. 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. READ.fcpool.Universe: Read a 'fcpool.Universe' resource. CREATE.feedback.FeedbackPost: Create a 'feedback.FeedbackPost' resource. CREATE.firmware.BiosDescriptor: Create a 'firmware.BiosDescriptor' resource. DELETE.firmware.BiosDescriptor: Delete a 'firmware.BiosDescriptor' resource. READ.firmware.BiosDescriptor: Read a 'firmware.BiosDescriptor' resource. UPDATE.firmware.BiosDescriptor: Update a 'firmware.BiosDescriptor' resource. CREATE.firmware.BoardControllerDescriptor: Create a 'firmware.BoardControllerDescriptor' resource. DELETE.firmware.BoardControllerDescriptor: Delete a 'firmware.BoardControllerDescriptor' resource. READ.firmware.BoardControllerDescriptor: Read a 'firmware.BoardControllerDescriptor' resource. UPDATE.firmware.BoardControllerDescriptor: Update 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. CREATE.firmware.CimcDescriptor: Create a 'firmware.CimcDescriptor' resource. DELETE.firmware.CimcDescriptor: Delete a 'firmware.CimcDescriptor' resource. READ.firmware.CimcDescriptor: Read a 'firmware.CimcDescriptor' resource. UPDATE.firmware.CimcDescriptor: Update a 'firmware.CimcDescriptor' resource. CREATE.firmware.DimmDescriptor: Create a 'firmware.DimmDescriptor' resource. DELETE.firmware.DimmDescriptor: Delete a 'firmware.DimmDescriptor' resource. READ.firmware.DimmDescriptor: Read a 'firmware.DimmDescriptor' resource. UPDATE.firmware.DimmDescriptor: Update 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. CREATE.firmware.DriveDescriptor: Create a 'firmware.DriveDescriptor' resource. DELETE.firmware.DriveDescriptor: Delete a 'firmware.DriveDescriptor' resource. READ.firmware.DriveDescriptor: Read a 'firmware.DriveDescriptor' resource. UPDATE.firmware.DriveDescriptor: Update 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. CREATE.firmware.GpuDescriptor: Create a 'firmware.GpuDescriptor' resource. DELETE.firmware.GpuDescriptor: Delete a 'firmware.GpuDescriptor' resource. READ.firmware.GpuDescriptor: Read a 'firmware.GpuDescriptor' resource. UPDATE.firmware.GpuDescriptor: Update a 'firmware.GpuDescriptor' resource. CREATE.firmware.HbaDescriptor: Create a 'firmware.HbaDescriptor' resource. DELETE.firmware.HbaDescriptor: Delete a 'firmware.HbaDescriptor' resource. READ.firmware.HbaDescriptor: Read a 'firmware.HbaDescriptor' resource. UPDATE.firmware.HbaDescriptor: Update a 'firmware.HbaDescriptor' resource. CREATE.firmware.IomDescriptor: Create a 'firmware.IomDescriptor' resource. DELETE.firmware.IomDescriptor: Delete a 'firmware.IomDescriptor' resource. READ.firmware.IomDescriptor: Read a 'firmware.IomDescriptor' resource. UPDATE.firmware.IomDescriptor: Update a 'firmware.IomDescriptor' resource. CREATE.firmware.MswitchDescriptor: Create a 'firmware.MswitchDescriptor' resource. DELETE.firmware.MswitchDescriptor: Delete a 'firmware.MswitchDescriptor' resource. READ.firmware.MswitchDescriptor: Read a 'firmware.MswitchDescriptor' resource. UPDATE.firmware.MswitchDescriptor: Update a 'firmware.MswitchDescriptor' resource. CREATE.firmware.NxosDescriptor: Create a 'firmware.NxosDescriptor' resource. DELETE.firmware.NxosDescriptor: Delete a 'firmware.NxosDescriptor' resource. READ.firmware.NxosDescriptor: Read a 'firmware.NxosDescriptor' resource. UPDATE.firmware.NxosDescriptor: Update a 'firmware.NxosDescriptor' resource. CREATE.firmware.PcieDescriptor: Create a 'firmware.PcieDescriptor' resource. DELETE.firmware.PcieDescriptor: Delete a 'firmware.PcieDescriptor' resource. READ.firmware.PcieDescriptor: Read a 'firmware.PcieDescriptor' resource. UPDATE.firmware.PcieDescriptor: Update a 'firmware.PcieDescriptor' resource. CREATE.firmware.PsuDescriptor: Create a 'firmware.PsuDescriptor' resource. DELETE.firmware.PsuDescriptor: Delete a 'firmware.PsuDescriptor' resource. READ.firmware.PsuDescriptor: Read a 'firmware.PsuDescriptor' resource. UPDATE.firmware.PsuDescriptor: Update a 'firmware.PsuDescriptor' resource. READ.firmware.RunningFirmware: Read a 'firmware.RunningFirmware' resource. UPDATE.firmware.RunningFirmware: Update a 'firmware.RunningFirmware' resource. CREATE.firmware.SasExpanderDescriptor: Create a 'firmware.SasExpanderDescriptor' resource. DELETE.firmware.SasExpanderDescriptor: Delete a 'firmware.SasExpanderDescriptor' resource. READ.firmware.SasExpanderDescriptor: Read a 'firmware.SasExpanderDescriptor' resource. UPDATE.firmware.SasExpanderDescriptor: Update a 'firmware.SasExpanderDescriptor' 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. CREATE.firmware.StorageControllerDescriptor: Create a 'firmware.StorageControllerDescriptor' resource. DELETE.firmware.StorageControllerDescriptor: Delete a 'firmware.StorageControllerDescriptor' resource. READ.firmware.StorageControllerDescriptor: Read a 'firmware.StorageControllerDescriptor' resource. UPDATE.firmware.StorageControllerDescriptor: Update 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.Upgrade: Create a 'firmware.Upgrade' resource. DELETE.firmware.Upgrade: Delete a 'firmware.Upgrade' resource. READ.firmware.Upgrade: Read 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. READ.forecast.Catalog: Read a 'forecast.Catalog' resource. READ.forecast.Definition: Read a 'forecast.Definition' resource. READ.forecast.Instance: Read 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. CREATE.hcl.CompatibilityStatus: Create a 'hcl.CompatibilityStatus' resource. READ.hcl.DriverImage: Read a 'hcl.DriverImage' resource. READ.hcl.ExemptedCatalog: Read a 'hcl.ExemptedCatalog' resource. CREATE.hcl.HyperflexSoftwareCompatibilityInfo: Create a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. DELETE.hcl.HyperflexSoftwareCompatibilityInfo: Delete a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. READ.hcl.HyperflexSoftwareCompatibilityInfo: Read a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. UPDATE.hcl.HyperflexSoftwareCompatibilityInfo: Update a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. READ.hcl.OperatingSystem: Read a 'hcl.OperatingSystem' resource. READ.hcl.OperatingSystemVendor: Read a 'hcl.OperatingSystemVendor' resource. READ.hcl.ServiceStatus: Read a 'hcl.ServiceStatus' resource. CREATE.hcl.SupportedDriverName: Create a 'hcl.SupportedDriverName' resource. READ.hyperflex.Alarm: Read a 'hyperflex.Alarm' resource. CREATE.hyperflex.AppCatalog: Create a 'hyperflex.AppCatalog' resource. DELETE.hyperflex.AppCatalog: Delete a 'hyperflex.AppCatalog' resource. READ.hyperflex.AppCatalog: Read a 'hyperflex.AppCatalog' resource. UPDATE.hyperflex.AppCatalog: Update 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. CREATE.hyperflex.CapabilityInfo: Create a 'hyperflex.CapabilityInfo' resource. DELETE.hyperflex.CapabilityInfo: Delete 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.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.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. 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. CREATE.hyperflex.FeatureLimitExternal: Create a 'hyperflex.FeatureLimitExternal' resource. DELETE.hyperflex.FeatureLimitExternal: Delete a 'hyperflex.FeatureLimitExternal' resource. READ.hyperflex.FeatureLimitExternal: Read a 'hyperflex.FeatureLimitExternal' resource. UPDATE.hyperflex.FeatureLimitExternal: Update a 'hyperflex.FeatureLimitExternal' resource. CREATE.hyperflex.FeatureLimitInternal: Create a 'hyperflex.FeatureLimitInternal' resource. DELETE.hyperflex.FeatureLimitInternal: Delete a 'hyperflex.FeatureLimitInternal' resource. READ.hyperflex.FeatureLimitInternal: Read a 'hyperflex.FeatureLimitInternal' resource. UPDATE.hyperflex.FeatureLimitInternal: Update a 'hyperflex.FeatureLimitInternal' resource. READ.hyperflex.Health: Read a 'hyperflex.Health' resource. CREATE.hyperflex.HxdpVersion: Create a 'hyperflex.HxdpVersion' resource. DELETE.hyperflex.HxdpVersion: Delete a 'hyperflex.HxdpVersion' resource. READ.hyperflex.HxdpVersion: Read a 'hyperflex.HxdpVersion' resource. UPDATE.hyperflex.HxdpVersion: Update a 'hyperflex.HxdpVersion' 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.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. 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.ServerFirmwareVersion: Create a 'hyperflex.ServerFirmwareVersion' resource. DELETE.hyperflex.ServerFirmwareVersion: Delete a 'hyperflex.ServerFirmwareVersion' resource. READ.hyperflex.ServerFirmwareVersion: Read a 'hyperflex.ServerFirmwareVersion' resource. UPDATE.hyperflex.ServerFirmwareVersion: Update a 'hyperflex.ServerFirmwareVersion' resource. CREATE.hyperflex.ServerModel: Create a 'hyperflex.ServerModel' resource. DELETE.hyperflex.ServerModel: Delete a 'hyperflex.ServerModel' resource. READ.hyperflex.ServerModel: Read a 'hyperflex.ServerModel' resource. UPDATE.hyperflex.ServerModel: Update a 'hyperflex.ServerModel' 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.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. 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. READ.iaas.ConnectorPack: Read a 'iaas.ConnectorPack' 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. DELETE.iaas.UcsdInfo: Delete a 'iaas.UcsdInfo' 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. CREATE.iam.AccountExperience: Create a 'iam.AccountExperience' 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. 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. READ.iam.DomainGroup: Read a 'iam.DomainGroup' 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. 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. 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. 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. 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. 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. 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. UPDATE.iam.LocalUserPassword: Update a 'iam.LocalUserPassword' resource. DELETE.iam.OAuthToken: Delete a 'iam.OAuthToken' resource. READ.iam.OAuthToken: Read a 'iam.OAuthToken' 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. READ.iam.PrivilegeSet: Read a 'iam.PrivilegeSet' 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. 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. READ.iam.System: Read a 'iam.System' 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. 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. CREATE.ippool.IpLease: Create a 'ippool.IpLease' 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. 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.kvm.KvmSession: Read a 'kvm.KvmSession' 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.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. CREATE.license.LicenseInfo: Create a 'license.LicenseInfo' resource. READ.license.LicenseInfo: Read a 'license.LicenseInfo' resource. UPDATE.license.LicenseInfo: Update a 'license.LicenseInfo' 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. 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. 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. READ.memory.Unit: Read a 'memory.Unit' resource. UPDATE.memory.Unit: Update a 'memory.Unit' resource. DELETE.meta.Definition: Delete a 'meta.Definition' resource. READ.meta.Definition: Read a 'meta.Definition' 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.VlanPortInfo: Read a 'network.VlanPortInfo' resource. UPDATE.network.VlanPortInfo: Update a 'network.VlanPortInfo' 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.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.NiaMetadata: Read a 'niaapi.NiaMetadata' resource. READ.niaapi.VersionRegex: Read a 'niaapi.VersionRegex' resource. READ.niatelemetry.Epg: Read a 'niatelemetry.Epg' resource. READ.niatelemetry.NiaFeatureUsage: Read a 'niatelemetry.NiaFeatureUsage' resource. READ.niatelemetry.NiaInventory: Read a 'niatelemetry.NiaInventory' resource. READ.niatelemetry.NiaLicenseState: Read a 'niatelemetry.NiaLicenseState' resource. READ.niatelemetry.Tenant: Read a 'niatelemetry.Tenant' 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. 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. 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. 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. CREATE.os.TemplateFile: Create a 'os.TemplateFile' 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.Link: Read a 'pci.Link' resource. UPDATE.pci.Link: Update a 'pci.Link' resource. READ.pci.Switch: Read a 'pci.Switch' resource. UPDATE.pci.Switch: Update a 'pci.Switch' 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.processor.Unit: Read a 'processor.Unit' resource. UPDATE.processor.Unit: Update a 'processor.Unit' 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. READ.resource.MembershipHolder: Read a 'resource.MembershipHolder' 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. CREATE.sdwan.Profile: Create a 'sdwan.Profile' resource. DELETE.sdwan.Profile: Delete a 'sdwan.Profile' resource. READ.sdwan.Profile: Read a 'sdwan.Profile' resource. UPDATE.sdwan.Profile: Update a 'sdwan.Profile' resource. CREATE.sdwan.RouterNode: Create a 'sdwan.RouterNode' resource. DELETE.sdwan.RouterNode: Delete a 'sdwan.RouterNode' resource. READ.sdwan.RouterNode: Read a 'sdwan.RouterNode' resource. UPDATE.sdwan.RouterNode: Update a 'sdwan.RouterNode' resource. CREATE.sdwan.RouterPolicy: Create a 'sdwan.RouterPolicy' resource. DELETE.sdwan.RouterPolicy: Delete a 'sdwan.RouterPolicy' resource. READ.sdwan.RouterPolicy: Read a 'sdwan.RouterPolicy' resource. UPDATE.sdwan.RouterPolicy: Update a 'sdwan.RouterPolicy' resource. CREATE.sdwan.VmanageAccountPolicy: Create a 'sdwan.VmanageAccountPolicy' resource. DELETE.sdwan.VmanageAccountPolicy: Delete a 'sdwan.VmanageAccountPolicy' resource. READ.sdwan.VmanageAccountPolicy: Read a 'sdwan.VmanageAccountPolicy' resource. UPDATE.sdwan.VmanageAccountPolicy: Update a 'sdwan.VmanageAccountPolicy' resource. READ.search.SearchItem: Read a 'search.SearchItem' resource. CREATE.search.SuggestItem: Create a 'search.SuggestItem' 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.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. 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. 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. 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. CREATE.software.HclMeta: Create a 'software.HclMeta' resource. DELETE.software.HclMeta: Delete a 'software.HclMeta' resource. READ.software.HclMeta: Read a 'software.HclMeta' resource. UPDATE.software.HclMeta: Update 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.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.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. CREATE.softwarerepository.CategoryMapper: Create a 'softwarerepository.CategoryMapper' resource. DELETE.softwarerepository.CategoryMapper: Delete a 'softwarerepository.CategoryMapper' resource. READ.softwarerepository.CategoryMapper: Read a 'softwarerepository.CategoryMapper' resource. UPDATE.softwarerepository.CategoryMapper: Update a 'softwarerepository.CategoryMapper' resource. CREATE.softwarerepository.CategoryMapperModel: Create a 'softwarerepository.CategoryMapperModel' resource. DELETE.softwarerepository.CategoryMapperModel: Delete a 'softwarerepository.CategoryMapperModel' resource. READ.softwarerepository.CategoryMapperModel: Read a 'softwarerepository.CategoryMapperModel' resource. UPDATE.softwarerepository.CategoryMapperModel: Update a 'softwarerepository.CategoryMapperModel' resource. CREATE.softwarerepository.CategorySupportConstraint: Create a 'softwarerepository.CategorySupportConstraint' resource. DELETE.softwarerepository.CategorySupportConstraint: Delete a 'softwarerepository.CategorySupportConstraint' resource. READ.softwarerepository.CategorySupportConstraint: Read a 'softwarerepository.CategorySupportConstraint' resource. UPDATE.softwarerepository.CategorySupportConstraint: Update a 'softwarerepository.CategorySupportConstraint' 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. CREATE.softwarerepository.Release: Create a 'softwarerepository.Release' resource. DELETE.softwarerepository.Release: Delete a 'softwarerepository.Release' resource. READ.softwarerepository.Release: Read a 'softwarerepository.Release' resource. UPDATE.softwarerepository.Release: Update 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. 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.storage.Controller: Read a 'storage.Controller' resource. UPDATE.storage.Controller: Update a 'storage.Controller' resource. READ.storage.DiskGroup: Read a 'storage.DiskGroup' resource. UPDATE.storage.DiskGroup: Update a 'storage.DiskGroup' resource. CREATE.storage.DiskGroupPolicy: Create a 'storage.DiskGroupPolicy' resource. DELETE.storage.DiskGroupPolicy: Delete a 'storage.DiskGroupPolicy' resource. READ.storage.DiskGroupPolicy: Read a 'storage.DiskGroupPolicy' resource. UPDATE.storage.DiskGroupPolicy: Update a 'storage.DiskGroupPolicy' 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.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.Item: Read a 'storage.Item' 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.PureController: Read a 'storage.PureController' resource. READ.storage.PureDisk: Read a 'storage.PureDisk' 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.PurePort: Read a 'storage.PurePort' resource. READ.storage.PureProtectionGroup: Read a 'storage.PureProtectionGroup' resource. READ.storage.PureProtectionGroupSnapshot: Read a 'storage.PureProtectionGroupSnapshot' resource. READ.storage.PureReplicationSchedule: Read a 'storage.PureReplicationSchedule' resource. READ.storage.PureSnapshotSchedule: Read a 'storage.PureSnapshotSchedule' resource. READ.storage.PureVolume: Read a 'storage.PureVolume' 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.VirtualDriveExtension: Read a 'storage.VirtualDriveExtension' resource. UPDATE.storage.VirtualDriveExtension: Update a 'storage.VirtualDriveExtension' 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. CREATE.tam.AdvisoryCount: Create a 'tam.AdvisoryCount' resource. DELETE.tam.AdvisoryCount: Delete a 'tam.AdvisoryCount' resource. READ.tam.AdvisoryCount: Read a 'tam.AdvisoryCount' resource. UPDATE.tam.AdvisoryCount: Update a 'tam.AdvisoryCount' resource. CREATE.tam.AdvisoryDefinition: Create a 'tam.AdvisoryDefinition' resource. DELETE.tam.AdvisoryDefinition: Delete a 'tam.AdvisoryDefinition' resource. READ.tam.AdvisoryDefinition: Read a 'tam.AdvisoryDefinition' resource. UPDATE.tam.AdvisoryDefinition: Update 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. CREATE.tam.AdvisoryInstance: Create a 'tam.AdvisoryInstance' resource. DELETE.tam.AdvisoryInstance: Delete a 'tam.AdvisoryInstance' resource. READ.tam.AdvisoryInstance: Read a 'tam.AdvisoryInstance' resource. UPDATE.tam.AdvisoryInstance: Update a 'tam.AdvisoryInstance' resource. CREATE.tam.SecurityAdvisory: Create a 'tam.SecurityAdvisory' resource. DELETE.tam.SecurityAdvisory: Delete a 'tam.SecurityAdvisory' resource. READ.tam.SecurityAdvisory: Read a 'tam.SecurityAdvisory' resource. UPDATE.tam.SecurityAdvisory: Update a 'tam.SecurityAdvisory' resource. CREATE.task.PureScopedInventory: Create a 'task.PureScopedInventory' resource. READ.techsupportmanagement.Download: Read a 'techsupportmanagement.Download' 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. 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. READ.uuidpool.Universe: Read a 'uuidpool.Universe' resource. READ.uuidpool.UuidLease: Read a 'uuidpool.UuidLease' 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.VmwareHost: Read a 'virtualization.VmwareHost' resource. UPDATE.virtualization.VmwareHost: Update a 'virtualization.VmwareHost' resource. READ.virtualization.VmwareVcenter: Read a 'virtualization.VmwareVcenter' resource. READ.virtualization.VmwareVirtualMachine: Read a 'virtualization.VmwareVirtualMachine' resource. UPDATE.virtualization.VmwareVirtualMachine: Update a 'virtualization.VmwareVirtualMachine' 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. 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. 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. 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. 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. 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. 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. 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. 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. 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.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.ScpStatus: Read a 'vnic.ScpStatus' 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.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.BuildTaskMeta: Read a 'workflow.BuildTaskMeta' resource. READ.workflow.BuildTaskMetaOwner: Read a 'workflow.BuildTaskMetaOwner' resource. READ.workflow.Catalog: Read a 'workflow.Catalog' 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. READ.workflow.PendingDynamicWorkflowInfo: Read a 'workflow.PendingDynamicWorkflowInfo' 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. 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.WorkflowMeta: Read a 'workflow.WorkflowMeta' resource.