API Reference Overview

The Intersight Open API specification is structured into categories, each containing smaller specification files for easier management and download. Here are the categories along with descriptions of the APIs within each category:

Fabric

capability

(Read-only) Return the capability catalogs that describe the hardware PIDs.

fabric

Manage fabric policies, domain profiles, and some fabric inventory objects.

• Fabric policies configure Intersight Fabric Interconnect and are associated with domain profiles. • Domain profiles are deployed on the Fabric Interconnect to configure the Fabric Interconnect for desired operations. • Fabric policies can be shared across domain profiles to reuse a single policy with multiple Fabric Interconnects.

network

Return the network device inventory objects that form the basis of Intersight operations.

port

Use port groups to separate Ethernet and FC port types. Use port subgroups to breakout ports of a single physical port.

sw

Internal APIs to maintain the device Fabric Interconnect (FI) state. Not exposed to account administrators.

Hyperflex

comm

Specify the HTTP proxy settings used for HyperFlex installation and storage controller VMs. This policy is required when server Internet access (including CIMC and HyperFlex storage controller VMs) is secured by an HTTP proxy.

forecast

Return about storage capacity runway functionality. These APIs provide:

• Catalog and definition objects—the basic configuration for the models used to make storage runway predictions.

• Instance objects—capacity runway information and the computed prediction model (if the minimum requirements for runway calculation set in the definition object are satisfied). Instance objects are created on a per-cluster basis.

hyperflex

View and manage HyperFlex clusters and associated objects such as datastores, volumes, drives, and hosts. These APIs provide:

• Policy and profile objects that define the configuration to deploy new HyperFlex clusters or perform lifecycle operations on existing clusters. • Inventory data from HyperFlex clusters for monitoring cluster storage usage, performance, and operational status.

recommendation

Recommendations generated by the capacity planning functionalities. These APIs provide:

• Objects that represent the physical items and the software recommendations generated for storage capacity runway and expansion recommendation. • Objects that accept user inputs for generating expansion recommendations. • A bill of materials (BOM) list and Cisco Commerce Workspace (CCW) estimate generated by an expansion recommendation request.

Kubernetes

cloud

Create and manage virtual machines and associated attributes in public cloud targets (such as AWS).

View inventory fetched from Terraform Cloud.

kubernetes

Create, manage, and monitor Intersight Kubernetes Service (IKS) clusters.

• Create cluster profiles and IP pools. • Simplify Kubernetes cluster deployment in Intersight.

Nexus Insights Advisor

niaapi

(Depreciated and replaced by networkElement) Get details of Nexus and MDS devices.

niatelemetry

Get network element (nexus and mds) details and generate contract status details.

Orchestrator

connectorpack

Determine the connector packs to be installed on a target UCS Director.

Download or install connector packs on a target device.

convergedinfra

Create and manage integrated systems such as FlexPod and other converged infrastructure solutions. Also returns compliance information for the integrated system, including server, storage and network.

iaas

(Read-only) Return UCS Director (UCSD) license info, service status, devices added and status. Also return infrastructure statistics, service request details, system task and custom task execution count.

ucsd

Return the backup information for the target UCS Director instance.

(Read-only) Return UCS Director (UCSD) license info, service status, devices added and status. Also return infrastructure statistics, service request details, system task and custom task execution count.

workflow

Manage the life cycle of workflow objects such as Task Definition, Workflow Definition, Custom Data Types, Batch API executors, and Error Response handlers.

• Start a workflow using WorkflowInfo. • View the workflow execution results using TaskInfo, Task Debug Logs, and WorkflowInfo (using the respective object IDs).

Server

access

All IMC Access Policy APIs.

adapter

Manage the physical and virtual settings of an adapter as seen by the host, including adapter inventory and configuration for Host Ethernet, FibreChannel and iSCSI Interface.

bios

Manage the BIOS token settings that can be applied to a Server through the BIOS policy. These APIs also manage the server boot devices and boot mode configuration.

boot

Manage the boot policy including the supported boot device types for a server.

chassis

Manage blade chassis types, identity, settings, and other information.

compute

Manage server types, identity, settings, and other information.

certificatemanagement

Manage server certificates such as IMC and HTTPS certificates.

deviceconnector

Manage the device connector policy for a standalone server. If enabled, the server can only be configured using Intersight.

fault

Return the faults for standalone and UCSM managed servers.

fcpool

Life cycle management of fibre channel (FC) pools and reservations, including lease deletion.

FC pools provide unique IDs for fibre channel resources on a server (fibre channel nodes and ports).

firmware

Upgrade server, chassis and switch firmware.

graphics

Configure and return information for server graphic cards.

ipmioverlan

Manage the server IPMI over LAN policy settings.

ippool

Life cycle management of IP pools and reservations, including lease deletion.

IP pools provide dynamically assigned IP addresses to services running on a network element.

iqnpool

Life cycle management of IQN pools and reservations, including lease deletion.

IQN pools provide a collection of iSCSI Qualified Names (IQNs) for use as initiator identifiers by iSCSI vNICs.

kvm

Launch vKVM and tunneled vKVM sessions.

ls

Manager server logical profiles.

inventory

Support any generic inventory object that does not conform to a specific device endpoint or platform type.

macpool

Life cycle management of MAC pools and reservations, including lease deletion.

MAC pools provide unique IDs for network interface ports.

management

Configure and return information for management interfaces used to monitor endpoints such as servers and Fabric Interconnects.

memory

Return server DIMM inventory and configure persistent memory units.

networkconfig

Configure the dynamic DNS and DNS settings of a standalone server for IPv4 and IPv6.

ntp

Manage the NTP policy for endpoints such as Fabric Interconnects and servers.

os

Install the operating system in Cisco, custom and embedded modes.

pci

Configure and return information for PCI devices in a server.

power

Manage the power policy features for chassis and servers.

processor

Configure and return information for server processors.

rack

Internal API used to model a server based on a defined personality without having to reprogram the server PID.

sdcard

Manage server SD cards.

security

Return the server crypto card information.

server

Manage servers, including: imports from the IMC, server disruptions including configuration changes, pending reboots, profile and profile templates.

smtp

Manage SMTP policies for standalone servers.

snmp

Manage SMTP policies for Fabric Interconnects, servers, or chassis.

sol

Manage Serial Over LAN policies for servers.

ssh

Manage SSH policies for standalone servers.

storage

Manage storage policy features for servers, including:

• Get inventory and configure the storage controller and attached physical drives. • Create, modify and delete the virtual drives on a server.

syslog

Manage syslog policies for Fabric Interconnects or servers.

tam

Returns the description and reference to published Intersight Advisory that identifies potential issues and resolution recommendations, if available.

terminal

Get the audit log for remote terminal user sessions.

thermal

Manage thermal management policies for chassis or servers.

uuidpool

Life cycle management of UUID pools and reservations, including lease deletion. UUID pools provide unique IDs for each server associated with the server profile.

vmedia

Manage Virtual Media policies for servers, which are used to install a server operating system using the KVM console and any supported virtual media types and protocols.

vnic

Life cycle management of server virtual interfaces created using LAN and SAN connectivity policies, including inventory and configuration support for virtual Ethernet and Fibre Channel interfaces.

vrf

Virtual route forwarding (VRF) used for IP Pools to configure overlapping IP addresses (different router domain).

Storage

Hitachi

View Hitachi VSP objects such as arrays, hosts, disks, volumes and other objects.

• These APIs return a holistic view of a Hitachi array and are used in the Intersight UI under the System>Infrastructure>Storage tab. • Use the provided ICO tasks and sample workflows to streamline end-to-end operations of the Hitachi objects.

NetApp

View NetApp AIQUM/ONTAP objects such as NetApp clusters, nodes, volumes, storage virtual machines, LUNs, and other objects.

• These APIs return a holistic view of an entire NetApp Cluster and are used in the Intersight UI, under the System>Infrastructure>Storage tab. • Use the provided ICO tasks and sample workflows to streamline end-to-end data centre operations. For example, create a new NAS / VMFS datastore that provisions and maps the LUN and volume from the ONTAP cluster to the VMware hosts.

Pure

View Pure Storage objects such as Pure Arrays, hosts, controllers, volumes, protection groups, and other objects.

• These APIs return a holistic view of a Pure Array and are used in the Intersight UI, under the System>Infrastructure>Storage tab. • Use the provided ICO tasks and sample workflows to streamline end-to-end operations of Pure storage objects.

Here is the given structure "###" alphabetically:

System

aaa

Returns AuditRecord configuration changes made by a user.

appliance

Manage Intersight Appliance platform installation, upgrade and administrative settings.

asset

Connect and manage Intersight targets. View high-level information about connected targets including associated contracts.

bulk

Batch processing functions such as:

• Combine multiple API calls (bulk/Requests). • Shallow or deep clone any Managed Object (bulk/MoCloners, bulk/MoDeepCloners). • Merge one-to-many allowed Managed Objects (bulk/MoMergers). • Bulk export MOs (bulk/Exports).

cond

Provides the HCL status of the servers. Represents various alarms and status that are determined by Intersight or reported by the managed system itself.

externalsite

(Deprecated) Authenticate and download files from external non-Cisco software repositories.

feedback

Submit feedback on Intersight.

hcl

Check the Cisco hardware compatibility for server hardware, software and adapter compliance.

iam

Provide authentication and authorization data including account, users, user groups, idp, domain names, sessions, privileges, and roles.

iwotenant

Returns Intersight Workload Optimizer (IWO) status and license related information.

license

Manage and monitor license usage and compliance.

meta

Return metadata about Intersight Rest APIs.

monitoring

Monitor historic and real-time device resource consumption such as power, memory, CPU, network, and other resources.

notification

Configure email and Webhook notifications.

oauth

Encapsulate the access token and authorization details for an OAuth connection between an Intersight account and an external OAuth provider.

oprs

API call to monitor the status of the operator deployed in the assist.

organization

Provide data required for Organization multi-tenancy.

recovery

Backup and restore a target endpoint, either on-demand or scheduled.

resource

Provide data required for Groups to implement multi-tenancy for Intersight physical resources.

resourcepool

Return information for a resource lease for user-created ResourcePool and PoolMember.

search

Search for Intersight resources via Elasticsearch, including multiple resource types in a single request.

software

Software image bundles and release details for Solutions, Hyperflex, UCS Director, and the private appliance specific Hyperflex, UCS director and IKS image bundles.

softwarerepository

Provide metadata for specifications, usage history, and authorization used to upload and download of files.

task

Define workflow tasks and task definition. Create standalone tasks for a single implementation of the task, or link a TaskDefinition to multiple implementation tasks.

techsupportmanagement

Collect and download techsupport log bundles from endpoints.

telemetry

Performs different types of queries like TopN, GroupBy, etc., on the time series data such as host power, system memory, system CPU.

top

The root (top-level) container MO for all child MOs associated with a UCSM Managed Domain, Standalone C-Series Servers, or Nexus MDS devices. It contains basic information such as hostname and/or management IP of the domain.

view

Join and aggregate data from endpoints to provide consolidated responses with superior support for query filtering, sorting, and aggregation.

Virtualization

virtualization

Read-only access to virtualization objects such as Host, Datastore, and Virtual Machine for both general and vendor-specific objects.

vmrc

Launch a VMRC console to a VMware virtual machine or host. A username/password credential is required.