The identity and technical contract details declared by the specification.
aaa.AbstractAuditRecord
AbstractAuditRecord is an abstract base type that specifies the common properties for all audit log records concrete sub-types.
aaa.AuditRecord.Response
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…
aaa.AuditRecord
The AuditRecord object is a crucial element within the system, providing a comprehensive overview of configuration changes made by users. It serves as a reliab…
aaa.AuditRecord.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
aaa.RetentionConfig.Response
The response body of a HTTP GET request for the 'aaa.RetentionConfig' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
aaa.RetentionConfig
The RetentionConfig object provides default configurations for audit log retention, offering a standardized approach to managing retention periods in the absen…
aaa.RetentionConfig.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
aaa.RetentionPolicy.Response
The response body of a HTTP GET request for the 'aaa.RetentionPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
aaa.RetentionPolicy
The RetentionPolicy object governs audit log retention policies at the account level, specifying the duration for which audit logs are preserved before automat…
aaa.RetentionPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
aaa.UserAgent
A user agent of an API request. The user agent has information about the operating system family and version that initiated the request. The user agent also ha…
apic.FabricLeafNodeDetails
Fabric leaf node details in APIC.
asset.AddressInformation
Type for saving the address information. It is used in asset.DeviceContractInformation object to save customer address.
asset.AlarmSummary
The summary of alarm counts based on alarm serverity.
asset.ApiKeyCredential
API key based authentication.
asset.ClaimSignature
A cryptographic signature that can be used to auto-claim a device connector into a user's account.
asset.ClaimToken.Response
The response body of a HTTP GET request for the 'asset.ClaimToken' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
asset.ClaimToken
The ClaimToken object serves as a secure mechanism for onboarding and registering devices to an Intersight user account. It facilitates a streamlined connectio…
asset.ClaimToken.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.ClientCertificateCredential
A credential which performs authentication with TLS client certificates.
asset.CloudConnection
CloudConnection provides the necessary details for Intersight to connect to and authenticate with a target at a well-known service address. The service address…
asset.ClusterMember.Response
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…
asset.ClusterMember.Relationship
A relationship to the 'asset.ClusterMember' resource, or the expanded 'asset.ClusterMember' resource, or the 'null' value.
asset.ClusterMember
The ClusterMember object represents a node within a cluster of device connectors. This provides detailed insights into the individual members of a device clust…
asset.ClusterMember.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.Connection
A method for Intersight to connect to a managed target, including network connectivity and authentication details.
asset.ConnectionFlapStatus
Encapsulates key details used to identify devices experiencing connection flapping.
asset.ContractInformation
Type for saving contract information.
asset.Credential
A credential which can be used to authenticate with a managed target.
asset.CustomerInformation
Type for saving contract information.
asset.Deployment.Response
The response body of a HTTP GET request for the 'asset.Deployment' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
asset.Deployment.Relationship
A relationship to the 'asset.Deployment' resource, or the expanded 'asset.Deployment' resource, or the 'null' value.
asset.Deployment
The Deployment object is an essential element of the Cisco consumption-based subscription ecosystem, providing detailed information about deployments associate…
asset.Deployment.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeploymentAlarmInfo
Persists the different alarm type flags.
asset.DeploymentDevice.Response
The response body of a HTTP GET request for the 'asset.DeploymentDevice' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
asset.DeploymentDevice.Relationship
A relationship to the 'asset.DeploymentDevice' resource, or the expanded 'asset.DeploymentDevice' resource, or the 'null' value.
asset.DeploymentDevice
The DeploymentDevice object is pivotal in managing device information within consumption-based subscriptions. This provides a detailed view of device installat…
asset.DeploymentDevice.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeploymentDeviceAlarmInfo
Persists the different alarm type flags.
asset.DeploymentDeviceInformation
Type for saving the device information reported by Cisco Install Base. It is used in asset.DeploymentDevice object to save the device information.
asset.DeviceClaim.Relationship
A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' resource, or the 'null' value.
asset.DeviceClaim
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 pe…
asset.DeviceConfiguration.Response
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 i…
asset.DeviceConfiguration.Relationship
A relationship to the 'asset.DeviceConfiguration' resource, or the expanded 'asset.DeviceConfiguration' resource, or the 'null' value.
asset.DeviceConfiguration
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 ex…
asset.DeviceConfiguration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceConnection.Relationship
A relationship to the 'asset.DeviceConnection' resource, or the expanded 'asset.DeviceConnection' resource, or the 'null' value.
asset.DeviceConnection
An abstract class that holds the details of a device connectors connection to Intersight.
asset.DeviceConnectorManager.Response
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 specifie…
asset.DeviceConnectorManager
The DeviceConnectorManager object is a central component in managing registered Intersight Assist Appliance Devices within the Intersight ecosystem. This provi…
asset.DeviceConnectorManager.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceContractInformation.Response
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 speci…
asset.DeviceContractInformation.Relationship
A relationship to the 'asset.DeviceContractInformation' resource, or the expanded 'asset.DeviceContractInformation' resource, or the 'null' value.
asset.DeviceContractInformation
The DeviceContractInformation object provides a comprehensive structure for managing contract-related information of Cisco devices identified by unique identif…
asset.DeviceContractInformation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceContractNotification
The DeviceContractNotification object facilitates communication between appliances and cloud systems, supporting contract status computations. It acts as an in…
asset.DeviceEndpointLocalCredential
Used against a device endpoint that manages its own local credential.
asset.DeviceInformation
Type for saving the device information reported by Cisco Install Base. It is used in asset.SubscriptionDeviceInformation object to save the device information.
asset.DeviceRegistration.Response
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…
asset.DeviceRegistration.Relationship
A relationship to the 'asset.DeviceRegistration' resource, or the expanded 'asset.DeviceRegistration' resource, or the 'null' value.
asset.DeviceRegistration
The DeviceRegistration object represents a device connector-enabled endpoint that has registered with Intersight. It is a concrete object central to the manage…
asset.DeviceRegistration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceStatistics
Type for saving device statistics related information for HyperFlex and UCS devices. It is used in asset.DeploymentDevice object to save the current device sta…
asset.DeviceTransaction
Type for saving the device transaction history. It is used in asset.DeploymentDeviceInformation object to save the device transactions.
asset.GenericTargetClaimOptions
Captures the generic set of options required to claim a generic target managed via assist. Should be used only by partners who are developing their integration…
asset.GeoLocation.Response
The response body of a HTTP GET request for the 'asset.GeoLocation' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
asset.GeoLocation.Relationship
A relationship to the 'asset.GeoLocation' resource, or the expanded 'asset.GeoLocation' resource, or the 'null' value.
asset.GeoLocation
The geographic location of a managed target.
asset.GeoLocation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.GlobalUltimate
Type for customer information of the BillToGlobal.
asset.GoogleCloudPlatformServiceAccountKeyCredential
Google APIs use the OAuth 2.0 protocol for authentication and authorization. Google Cloud Platform (GCP) service account's key JSON file to get an access token…
asset.HttpConnection
HttpConnection provides the necessary details for Intersight to connect to and authenticate with a managed target over an HTTP connection.
asset.IntersightDeviceConnectorConnection
Target is connected to Intersight using a Device Connector.
asset.MerakiCloudOptions
Captures the Meraki organization Id that is mapped to the claimed target.
asset.MeteringType
Type for saving Metering details.
asset.NewRelicCredential
Credentials for authenticating with a NewRelic target. Management of a NewRelic target leverages multiple management interfaces and this credential object cont…
asset.NoAuthenticationCredential
Used against a target which does not require any credential.
asset.OauthBearerTokenCredential
A credential which performs authentication based on a bearer token.
asset.OauthClientIdSecretCredential
An OAuth credential which performs authentication based on a client ID and client Secret.
asset.OrchestrationCivpVmwareVcenterOptions
Captures configuration specific to the VMware Vcenter target for the VSphere Remote Plugin.
asset.OrchestrationHitachiVirtualStoragePlatformOptions
Captures configuration specific to the Hitachi Virtual Storage Platform target for the Orchestration service.
asset.OrchestrationHsmVmwareVcenterOptions
Captures configuration specific to the VMware Vcenter target for the Hardware Support Manager.
asset.OrchestrationService
OrchestrationService provides the necessary configuration details to enable Intersight Orchestration on the selected managed target. Subject to licensing.
asset.ParentConnectionSignature
A signature generated by a device connector with its private key. Signature is passed to leaf device connectors to authenticate connectivity between devices.
asset.PreClaim
The PreClaim object is a specialized component of the device management system designed to facilitate the completion of the claim process for pre-provisioned a…
asset.PrivateKeyCredential
A credential which performs authentication based on a private key for targets like SSH Endpoint. PrivateKeyCredential used to establish password-less SSH conne…
asset.ProductInformation
Type for saving the product information.
asset.ScopedTargetConnection
ScopedTargetConnection provides the necessary details for Intersight to connect to and authenticate with a managed scoped target such as msSQL, mySQL and Oracl…
asset.Service
A service that is enabled on a managed target. For example, Intersight Orchestration or Intersight Workload Optimizer.
asset.ServiceNowCredential
Credentials for authenticating with a ServiceNow target. Management of a ServiceNow target leverages multiple management interfaces and this credential object…
asset.ServiceOptions
ServiceOptions captures configuration that is specific to a target type for a specific service.
asset.SplunkTokenCredential
A credential which performs authentication based on Splunk token.
asset.SshConnection
SshConnection provides the necessary details for Intersight to connect and authenticate with a managed target over an SSH connection.
asset.Subscription.Response
The response body of a HTTP GET request for the 'asset.Subscription' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
asset.Subscription.Relationship
A relationship to the 'asset.Subscription' resource, or the expanded 'asset.Subscription' resource, or the 'null' value.
asset.Subscription
The Subscription object is central to managing consumption-based subscriptions within the Cisco technology ecosystem. It encapsulates details about the subscri…
asset.Subscription.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.SubscriptionAccount.Response
The response body of a HTTP GET request for the 'asset.SubscriptionAccount' resource. The value may be one of the following types. 1. When 'tag' is specified i…
asset.SubscriptionAccount.Relationship
A relationship to the 'asset.SubscriptionAccount' resource, or the expanded 'asset.SubscriptionAccount' resource, or the 'null' value.
asset.SubscriptionAccount
The SubscriptionAccount object is a foundational element within the subscription management framework, acting as a placeholder for the account collection. Its…
asset.SubscriptionAccount.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.SubscriptionDeviceContractInformation.Response
The response body of a HTTP GET request for the 'asset.SubscriptionDeviceContractInformation' resource. The value may be one of the following types. 1. When 't…
asset.SubscriptionDeviceContractInformation
The SubscriptionDeviceContractInformation object is a crucial component of asset management within the Cisco ecosystem, designed to encapsulate information reg…
asset.SubscriptionDeviceContractInformation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.SudiInfo
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 pub…
asset.Target.Response
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 que…
asset.Target.Relationship
A relationship to the 'asset.Target' resource, or the expanded 'asset.Target' resource, or the 'null' value.
asset.Target
The Target object represents an entity managed by Intersight. It encompasses both physical and software entities, such as UCS servers or cloud accounts, and se…
asset.Target.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.TargetKey
Holds a key and signature that can be sent in a device registration request to associate it with a target.
asset.TargetSignature
A signature generated by Intersight on creation of a target.
asset.TargetStatusDetails
TargetStatusDetails provides per component detailed status information. This information is normalized into a single status value which is presented to users.…
asset.TerraformIntegrationService
TerraformIntegrationService provides the necessary configuration details to enable Intersight Cloud Region on the selected Terraform Cloud.
asset.TerraformIntegrationTerraformAgentOptions
Cloud options for Terrraform Agent platform type.
asset.TerraformIntegrationTerraformCloudOptions
Cloud options for Terraform Cloud platform type.
asset.Token
A token that is generated by an Intersight user to claim a device. The token is used by the device administrator to configure and claim the device connector to…
asset.UsernamePasswordCredential
A credential which performs authentication based on a username and password.
asset.VirtualizationAmazonWebServiceOptions
Captures Virtualization Service configuration specific to AWS.
asset.VirtualizationCloudOptions
Captures Virtualization service configuration.
asset.VirtualizationService
The necessary configuration details to enable Intersight Virtualization features on the selected managed target.
asset.VmHost
Type for saving VM host details.
asset.WorkloadOptimizerAmazonWebServicesBillingOptions
Captures configuration specific to the Amazon web service (AWS) target for Workload Optimizer service. Following explanation is for S3 parameters for configuri…
asset.WorkloadOptimizerDynatraceOptions
Captures configuration specific to the Dynatrace target for the Workload Optimizer service.
asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions
Captures configuration specific to the Google Cloud Platform (GCP) Billing target for Workload Optimizer service.
asset.WorkloadOptimizerHypervOptions
Captures configuration specific to the Hyper-V target for the Workload Optimizer service.
asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions
Captures configuration specific to the Microsoft Azure Application Intersight target for the Workload Optimizer service.
asset.WorkloadOptimizerMicrosoftAzureBillingOptions
Captures configuration specific to the Microsoft Azure Billing target for the Workload Optimizer service.
asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions
Captures configuration specific to the Microsoft Azure Enterprise Agreement target for the Workload Optimizer service.
asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions
Captures configuration specific to the Microsoft Azure Service Principal target for the Workload Optimizer service.
asset.WorkloadOptimizerMicrosoftSqlServerOptions
Captures configuration specific to the Microsoft SQL Server target for the Workload Optimizer service.
asset.WorkloadOptimizerNewRelicOptions
Captures configuration specific to the NewRelic target for the Workload Optimizer service.
asset.WorkloadOptimizerOpenStackOptions
Captures configuration specific to the OpenStack target for the Workload Optimizer service.
asset.WorkloadOptimizerOracleDatabaseServerOptions
Captures configuration specific to the Oracle Database Server target for the Workload Optimizer service.
asset.WorkloadOptimizerRedHatOpenStackOptions
Captures configuration specific to the RedHat OpenStack target for the Workload Optimizer service.
asset.WorkloadOptimizerService
WorkloadOptimizerService provides the necessary configuration details to enable Intersight Workflow Optimizer on the selected managed target. Subject to licens…
asset.WorkloadOptimizerVmwareVcenterOptions
Captures configuration specific to the VMware Vcenter target for the Workload Optimizer service.
catalystsdwan.ConfigGroup.Response
The response body of a HTTP GET request for the 'catalystsdwan.ConfigGroup' resource. The value may be one of the following types. 1. When 'tag' is specified i…
catalystsdwan.ConfigGroup
Details for the Catalyst SDWAN config groups.
catalystsdwan.ConfigGroup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.Interface.Response
The response body of a HTTP GET request for the 'catalystsdwan.Interface' resource. The value may be one of the following types. 1. When 'tag' is specified in…
catalystsdwan.Interface
Details for the WAN Edge Device L3 interfaces (Portchannel, sub-interfaces, tunnels, SVIs, Routed ports).
catalystsdwan.Interface.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.InventoryEntity
Base object type for all Catalyst SDWAN WAN Edge inventory items.
catalystsdwan.PhysicalPort.Response
The response body of a HTTP GET request for the 'catalystsdwan.PhysicalPort' resource. The value may be one of the following types. 1. When 'tag' is specified…
catalystsdwan.PhysicalPort
Physical ports belonging to a WAN Edge Device.
catalystsdwan.PhysicalPort.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.PolicyGroup.Response
The response body of a HTTP GET request for the 'catalystsdwan.PolicyGroup' resource. The value may be one of the following types. 1. When 'tag' is specified i…
catalystsdwan.PolicyGroup
Details for the Catalyst SDWAN policy groups.
catalystsdwan.PolicyGroup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.PortChannel.Response
The response body of a HTTP GET request for the 'catalystsdwan.PortChannel' resource. The value may be one of the following types. 1. When 'tag' is specified i…
catalystsdwan.PortChannel
Details for the WAN Edge Device port channels.
catalystsdwan.PortChannel.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.VedgeDevice.Response
The response body of a HTTP GET request for the 'catalystsdwan.VedgeDevice' resource. The value may be one of the following types. 1. When 'tag' is specified i…
catalystsdwan.VedgeDevice
VedgeDevice is deprecated. Going forward WanEdgeDevice will be used to store details for the Catalyst SDWAN Vedge entities.
catalystsdwan.VedgeDevice.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.Vlan.Response
The response body of a HTTP GET request for the 'catalystsdwan.Vlan' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
catalystsdwan.Vlan
Details for the WAN Edge Device VLAN entities.
catalystsdwan.Vlan.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.WanEdgeDevice.Response
The response body of a HTTP GET request for the 'catalystsdwan.WanEdgeDevice' resource. The value may be one of the following types. 1. When 'tag' is specified…
catalystsdwan.WanEdgeDevice.Relationship
A relationship to the 'catalystsdwan.WanEdgeDevice' resource, or the expanded 'catalystsdwan.WanEdgeDevice' resource, or the 'null' value.
catalystsdwan.WanEdgeDevice
Details for the Catalyst SDWAN WAN Edge entities.
catalystsdwan.WanEdgeDevice.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
connectorpack.ConnectorPackUpdate
Connector Pack updates available on UCS Director.
connectorpack.ConnectorPackUpgrade.Response
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 sp…
connectorpack.ConnectorPackUpgrade
Used to download or install connector packs on the target device.
connectorpack.ConnectorPackUpgrade.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
connectorpack.UpgradeImpact.Response
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…
connectorpack.UpgradeImpact
The UpgradeImpact object is designed to assess and identify the list of connector packs to be installed or upgraded on UCS Director. It identifies the requisit…
connectorpack.UpgradeImpact.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.AdapterComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.AdapterComplianceDetails' resource. The value may be one of the following types. 1. When 'tag'…
convergedinfra.AdapterComplianceDetails.Relationship
A relationship to the 'convergedinfra.AdapterComplianceDetails' resource, or the expanded 'convergedinfra.AdapterComplianceDetails' resource, or the 'null' val…
convergedinfra.AdapterComplianceDetails
The AdapterComplianceDetails object captures compliance details for adapters within servers of a converged infrastructure pod, focusing on hardware compatibili…
convergedinfra.AdapterComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.AlarmSummary
The summary of alarm counts based on alarm serverity.
convergedinfra.BaseComplianceDetails.Relationship
A relationship to the 'convergedinfra.BaseComplianceDetails' resource, or the expanded 'convergedinfra.BaseComplianceDetails' resource, or the 'null' value.
convergedinfra.BaseComplianceDetails
Abstract type for all compliance details that may be part of a converged infrastructure pod.
convergedinfra.BasePod
Abstract base type for all pods.
convergedinfra.BasePodSummary
Summary information for the base pod. This inclues properties like number of nodes, stroage capacity/utilization, aggregated alarms for all the components of t…
convergedinfra.ComplianceSummary
The summary of compliance information based on the compliance analysis (HCL, IMT, etc.) of components.
convergedinfra.Pod.Response
The response body of a HTTP GET request for the 'convergedinfra.Pod' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
convergedinfra.Pod.Relationship
A relationship to the 'convergedinfra.Pod' resource, or the expanded 'convergedinfra.Pod' resource, or the 'null' value.
convergedinfra.Pod
Overview The Pod object represents a unit of deployment within a converged infrastructure. It encompasses inventory details related to health, hardware compati…
convergedinfra.Pod.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.PodComplianceInfo.Response
The response body of a HTTP GET request for the 'convergedinfra.PodComplianceInfo' resource. The value may be one of the following types. 1. When 'tag' is spec…
convergedinfra.PodComplianceInfo.Relationship
A relationship to the 'convergedinfra.PodComplianceInfo' resource, or the expanded 'convergedinfra.PodComplianceInfo' resource, or the 'null' value.
convergedinfra.PodComplianceInfo
The PodComplianceInfo object captures compliance information for a converged infrastructure pod, extending the base compliance details to include specific comp…
convergedinfra.PodComplianceInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.PodSummary
Summary information for the Pod, this is extenstion of properties defined in basePodSummary.
convergedinfra.ServerComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.ServerComplianceDetails' resource. The value may be one of the following types. 1. When 'tag' i…
convergedinfra.ServerComplianceDetails.Relationship
A relationship to the 'convergedinfra.ServerComplianceDetails' resource, or the expanded 'convergedinfra.ServerComplianceDetails' resource, or the 'null' value.
convergedinfra.ServerComplianceDetails
The ServerComplianceDetails object provides compliance information for servers within a converged infrastructure pod, detailing hardware compatibility and oper…
convergedinfra.ServerComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.StorageComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.StorageComplianceDetails' resource. The value may be one of the following types. 1. When 'tag'…
convergedinfra.StorageComplianceDetails.Relationship
A relationship to the 'convergedinfra.StorageComplianceDetails' resource, or the expanded 'convergedinfra.StorageComplianceDetails' resource, or the 'null' val…
convergedinfra.StorageComplianceDetails
The StorageComplianceDetails object provides compliance information for storage arrays within a converged infrastructure pod, assessing their interoperability…
convergedinfra.StorageComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.SwitchComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.SwitchComplianceDetails' resource. The value may be one of the following types. 1. When 'tag' i…
convergedinfra.SwitchComplianceDetails.Relationship
A relationship to the 'convergedinfra.SwitchComplianceDetails' resource, or the expanded 'convergedinfra.SwitchComplianceDetails' resource, or the 'null' value.
convergedinfra.SwitchComplianceDetails
The SwitchComplianceDetails object captures compliance information for switches, such as Fabric Interconnects, Nexus, and MDS, within a converged infrastructur…
convergedinfra.SwitchComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.Device.Response
The response body of a HTTP GET request for the 'dnac.Device' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
dnac.Device
The Device object is a comprehensive representation of network devices, facilitating the management and operational integration of network hardware within the…
dnac.Device.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.DeviceInterface.Response
The response body of a HTTP GET request for the 'dnac.DeviceInterface' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
dnac.DeviceInterface
The DeviceInterface object represents the network device interfaces, offering a structured approach to managing device connections and configurations. Purpose…
dnac.DeviceInterface.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.ExternalBorderNode.Response
The response body of a HTTP GET request for the 'dnac.ExternalBorderNode' resource. The value may be one of the following types. 1. When 'tag' is specified in…
dnac.ExternalBorderNode
The ExternalBorderNode object represents the external boundaries of a network, focusing on the management and configuration of nodes that interact with externa…
dnac.ExternalBorderNode.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.ExternalBorderNodeInterface.Response
The response body of a HTTP GET request for the 'dnac.ExternalBorderNodeInterface' resource. The value may be one of the following types. 1. When 'tag' is spec…
dnac.ExternalBorderNodeInterface
The ExternalBorderNodeInterface object serves as the gateway between a network and external entities, focusing on interface management and configuration. Purpo…
dnac.ExternalBorderNodeInterface.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.FabricSite.Response
The response body of a HTTP GET request for the 'dnac.FabricSite' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
dnac.FabricSite
The FabricSite object is a critical component within the network management framework, designed to represent and manage the physical or logical sites within th…
dnac.FabricSite.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.InventoryEntity
Base object type for all Dnac Inventory items.
dnac.Site.Response
The response body of a HTTP GET request for the 'dnac.Site' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
dnac.Site
The Site object serves as a detailed representation of a network site, encompassing essential site information required for comprehensive network management. T…
dnac.Site.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.SiteIpPool.Response
The response body of a HTTP GET request for the 'dnac.SiteIpPool' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
dnac.SiteIpPool
The SiteIpPool object provides a structured approach to managing IP pools associated with network sites, ensuring efficient and organized IP address allocation…
dnac.SiteIpPool.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.Template.Response
The response body of a HTTP GET request for the 'dnac.Template' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
dnac.Template
The Template object encapsulates the configuration and management of templates within the network system, supporting standardized and efficient deployment of c…
dnac.Template.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.Transit.Response
The response body of a HTTP GET request for the 'dnac.Transit' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
dnac.Transit
The Transit object is integral to network connectivity, representing transit paths and configurations that facilitate communication between different network s…
dnac.Transit.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
dnac.VirtualNetworkFabricSite.Response
The response body of a HTTP GET request for the 'dnac.VirtualNetworkFabricSite' resource. The value may be one of the following types. 1. When 'tag' is specifi…
dnac.VirtualNetworkFabricSite
The VirtualNetworkFabricSite object encapsulates the virtual networking aspects of a fabric site, enabling advanced network configurations and interactions. It…
dnac.VirtualNetworkFabricSite.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
energy.DailyMetrics
Returns carbon intensity, power breakdown, and electricity rate power metrics for a set of locations and a time span.
energy.Metrics
Returns carbon intensity, power breakdown, and electricity rate power metrics for a set of locations and a time span.
feedback.FeedbackData
Feedback data collected from the user through the UI.
feedback.FeedbackPost
The FeedbackPost object serves as the initial entry point for user feedback within the system. This provides a mechanism for users to submit their comments and…
fmc.Device.Response
The response body of a HTTP GET request for the 'fmc.Device' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
fmc.Device
The device details of the FMC.
fmc.Device.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
fmc.DeviceHaPair.Response
The response body of a HTTP GET request for the 'fmc.DeviceHaPair' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
fmc.DeviceHaPair
FMC HA device pair details.
fmc.DeviceHaPair.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
fmc.Domain.Response
The response body of a HTTP GET request for the 'fmc.Domain' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
fmc.Domain
The domain details of the FMC.
fmc.Domain.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
fmc.InventoryEntity
The base object type for all APIC inventory items.
fmc.PhysicalInterface.Response
The response body of a HTTP GET request for the 'fmc.PhysicalInterface' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
fmc.PhysicalInterface
Physical interface of the FMC device.
fmc.PhysicalInterface.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.ConnectorPack.Response
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 U…
iaas.ConnectorPack.Relationship
A relationship to the 'iaas.ConnectorPack' resource, or the expanded 'iaas.ConnectorPack' resource, or the 'null' value.
iaas.ConnectorPack
The ConnectorPack object is essential for managing connector pack versions within UCS Director (UCSD), facilitating configuration and dependency management. Pu…
iaas.ConnectorPack.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.CustomTaskInfo.Response
The response body of a HTTP GET request for the 'iaas.CustomTaskInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iaas.CustomTaskInfo.Relationship
A relationship to the 'iaas.CustomTaskInfo' resource, or the expanded 'iaas.CustomTaskInfo' resource, or the 'null' value.
iaas.CustomTaskInfo
The CustomTaskInfo object offers insights into the execution of custom tasks within UCS Director (UCSD), supporting workflow customization and management. Purp…
iaas.CustomTaskInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.DeviceStatus.Response
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 UR…
iaas.DeviceStatus.Relationship
A relationship to the 'iaas.DeviceStatus' resource, or the expanded 'iaas.DeviceStatus' resource, or the 'null' value.
iaas.DeviceStatus
The DeviceStatus object is pivotal in managing infrastructure accounts within UCS Director (UCSD), offering insights into connection status and device details.…
iaas.DeviceStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.DiagnosticMessages.Response
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…
iaas.DiagnosticMessages
The DiagnosticMessages object is vital for capturing diagnostic alerts and messages within UCS Director (UCSD), aiding in system health monitoring and issue re…
iaas.DiagnosticMessages.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.LicenseInfo.Response
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…
iaas.LicenseInfo.Relationship
A relationship to the 'iaas.LicenseInfo' resource, or the expanded 'iaas.LicenseInfo' resource, or the 'null' value.
iaas.LicenseInfo
The LicenseInfo object is a fundamental component in managing license details within UCS Director (UCSD), providing a structured overview of license types and…
iaas.LicenseInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.LicenseKeysInfo
Overview The LicenseKeysInfo object serves as an essential element in managing license details within UCS Director. It encapsulates information about unique li…
iaas.LicenseUtilizationInfo
Overview The LicenseUtilizationInfo object is crucial for managing and understanding the utilization of licenses within the UCS Director (UCSD). This provides…
iaas.MostRunTasks.Response
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 UR…
iaas.MostRunTasks.Relationship
A relationship to the 'iaas.MostRunTasks' resource, or the expanded 'iaas.MostRunTasks' resource, or the 'null' value.
iaas.MostRunTasks
The MostRunTasks object provides insights into frequently executed workflow tasks within UCS Director (UCSD). Purpose MostRunTasks captures data about task exe…
iaas.MostRunTasks.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.ServiceRequest.Response
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…
iaas.ServiceRequest
The ServiceRequest object is integral to managing service requests within UCS Director (UCSD), capturing essential details about service request and statuses r…
iaas.ServiceRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.SystemTaskInfo.Response
The response body of a HTTP GET request for the 'iaas.SystemTaskInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iaas.SystemTaskInfo.Relationship
A relationship to the 'iaas.SystemTaskInfo' resource, or the expanded 'iaas.SystemTaskInfo' resource, or the 'null' value.
iaas.SystemTaskInfo
The SystemTaskInfo object provides details about library task executions within UCS Director (UCSD), supporting system oversight and process management. Purpos…
iaas.SystemTaskInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.UcsdInfo.Response
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 qu…
iaas.UcsdInfo.Relationship
A relationship to the 'iaas.UcsdInfo' resource, or the expanded 'iaas.UcsdInfo' resource, or the 'null' value.
iaas.UcsdInfo
The UcsdInfo object is a central component in managing UCS Director accounts, offering insights into system configurations and connection status. It facilitate…
iaas.UcsdInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.UcsdManagedInfra.Response
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 th…
iaas.UcsdManagedInfra.Relationship
A relationship to the 'iaas.UcsdManagedInfra' resource, or the expanded 'iaas.UcsdManagedInfra' resource, or the 'null' value.
iaas.UcsdManagedInfra
The UcsdManagedInfra object is critical for overseeing UCS Director (UCSD) managed infrastructure, providing statistics and insights into managed resources. Pu…
iaas.UcsdManagedInfra.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.UcsdMessages.Response
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 UR…
iaas.UcsdMessages
The UcsdMessages object captures messages from UCS Director (UCSD), supporting system communication and alert management. Purpose UcsdMessages document system…
iaas.UcsdMessages.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.WorkflowSteps
Overview The WorkflowSteps object is integral to managing workflow operations within UCS Director (UCSD), capturing the step-by-step progression of service req…
iam.AbstractClientApplication.Relationship
A relationship to the 'iam.AbstractClientApplication' resource, or the expanded 'iam.AbstractClientApplication' resource, or the 'null' value.
iam.AbstractClientApplication
Describes an internal application registered against an endpoint in Intersight. The application receives requests specific to its use case and these requests r…
iam.AbstractQualifier.Relationship
A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.
iam.AbstractQualifier
Placeholder for different types of qualifiers.
iam.Account.Response
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 quer…
iam.Account.Relationship
A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.
iam.Account
The Account object defines the organizational framework within which users and resources are managed, serving as the central hub for access and permissions. Pu…
iam.Account.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.AccountExperience.Response
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 th…
iam.AccountExperience
AccountExperience captures the set of beta or preview features enabled for a specific account. Purpose It allows controlled enablement of new capabilities for…
iam.AccountExperience.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.AccountPermissions
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 iden…
iam.AccountTags
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.
iam.AccountTypeBase
Base type for all user account types in the endpoint user management system. It defines the shared structure and properties that are common to all account type…
iam.AccountTypeIpmi
Account type for creating IPMI user on the endpoint. IPMI user enables IPMI User on the endpoint.
iam.AccountTypeLocal
Account type for creating local user on the endpoint. Local user enables Redfish User on the endpoint.
iam.ApiKey.Response
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…
iam.ApiKey.Relationship
A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.
iam.ApiKey
The ApiKey object is a critical component for secure authentication and authorization within the system. It allows clients to make API requests programmaticall…
iam.ApiKey.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.AppCredentials
Contains credentials information for a particular client application.
iam.AppRegistration.Response
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…
iam.AppRegistration.Relationship
A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' resource, or the 'null' value.
iam.AppRegistration
The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials. Purpose An AppR…
iam.AppRegistration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.BannerMessage.Response
The response body of a HTTP GET request for the 'iam.BannerMessage' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iam.BannerMessage
BannerMessage configures a global banner for an account, controlling whether it is displayed and what content it shows. Purpose It provides a mechanism to comm…
iam.BannerMessage.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.BasicAuthCredentials
Defines a credentials Holder for Basic authentication.
iam.Certificate.Response
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…
iam.Certificate.Relationship
A relationship to the 'iam.Certificate' resource, or the expanded 'iam.Certificate' resource, or the 'null' value.
iam.Certificate
Certificate holds a user-provided certificate (signed by a CA) associated with a previously generated CSR, including validation status. Purpose It completes th…
iam.Certificate.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.CertificateRequest.Response
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 t…
iam.CertificateRequest.Relationship
A relationship to the 'iam.CertificateRequest' resource, or the expanded 'iam.CertificateRequest' resource, or the 'null' value.
iam.CertificateRequest
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 applyi…
iam.CertificateRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ClientMeta
Contains meta information of the client. Currently it is used only within OAuth clients.
iam.CuiIntegration.Response
The response body of a HTTP GET request for the 'iam.CuiIntegration' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
iam.CuiIntegration
Stores CUI and CCC integration details and synchronization status for an account.
iam.CuiIntegration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.DefaultAuthentication.Response
The response body of a HTTP GET request for the 'iam.DefaultAuthentication' resource. The value may be one of the following types. 1. When 'tag' is specified i…
iam.DefaultAuthentication
DefaultAuthentication specifies the default login method for an account in appliance contexts, optionally linking to a default LDAP domain. Purpose It streamli…
iam.DefaultAuthentication.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.DefaultPermissionInfo
Contains information about a stored default permission and its shared login interface coverage for product-facing default role selection.
iam.DomainGroup.Response
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…
iam.DomainGroup.Relationship
A relationship to the 'iam.DomainGroup' resource, or the expanded 'iam.DomainGroup' resource, or the 'null' value.
iam.DomainGroup
Intersight services are mapped to three different categories of services for scaling purpose. Three categories are defined: Partition1/Partition2/Partition3. T…
iam.DomainGroup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.DomainNameInfo.Response
The response body of a HTTP GET request for the 'iam.DomainNameInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
iam.DomainNameInfo
The organisation's domain name such as cisco.com that has been used to log in to Intersight.
iam.DomainNameInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EncryptedOidcAuthTokenSet
Holds attributes obtained after OIDC authentication in encrypted format which are required for CUI admin portal MFE inside Intersight for IdP settings and rout…
iam.EndPointPasswordProperties
Password properties for endpoint users.
iam.EndPointPrivilege.Response
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 th…
iam.EndPointPrivilege.Relationship
A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.
iam.EndPointPrivilege
EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions. Purpose It exposes endpoint-side…
iam.EndPointPrivilege.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointRole.Response
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…
iam.EndPointRole.Relationship
A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.
iam.EndPointRole
EndPointRole represents roles defined on managed endpoints that encapsulate one or more endpoint privileges. Purpose It allows administrators to assign endpoin…
iam.EndPointRole.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointUser.Response
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…
iam.EndPointUser.Relationship
A relationship to the 'iam.EndPointUser' resource, or the expanded 'iam.EndPointUser' resource, or the 'null' value.
iam.EndPointUser
The IAM EndPointUser object represents a single local user account. It is a building block used within the EndPointUserPolicy to define the users that should b…
iam.EndPointUser.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointUserInventory.Response
The response body of a HTTP GET request for the 'iam.EndPointUserInventory' resource. The value may be one of the following types. 1. When 'tag' is specified i…
iam.EndPointUserInventory.Relationship
A relationship to the 'iam.EndPointUserInventory' resource, or the expanded 'iam.EndPointUserInventory' resource, or the 'null' value.
iam.EndPointUserInventory
The IAM EndPointUser object represents a single local user account. It is a building block used within the EndPointUserPolicy to define the users that should b…
iam.EndPointUserInventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointUserPolicy.Response
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 t…
iam.EndPointUserPolicy.Relationship
A relationship to the 'iam.EndPointUserPolicy' resource, or the expanded 'iam.EndPointUserPolicy' resource, or the 'null' value.
iam.EndPointUserPolicy
The IAM EndPointUserPolicy object is a reusable policy that enables the creation and management of local user accounts on endpoints, such as server management…
iam.EndPointUserPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointUserPolicyInventory.Response
The response body of a HTTP GET request for the 'iam.EndPointUserPolicyInventory' resource. The value may be one of the following types. 1. When 'tag' is speci…
iam.EndPointUserPolicyInventory.Relationship
A relationship to the 'iam.EndPointUserPolicyInventory' resource, or the expanded 'iam.EndPointUserPolicyInventory' resource, or the 'null' value.
iam.EndPointUserPolicyInventory
The IAM EndPointUserPolicy object is a reusable policy that enables the creation and management of local user accounts on endpoints, such as server management…
iam.EndPointUserPolicyInventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointUserRole.Response
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…
iam.EndPointUserRole.Relationship
A relationship to the 'iam.EndPointUserRole' resource, or the expanded 'iam.EndPointUserRole' resource, or the 'null' value.
iam.EndPointUserRole
The IAM EndPointUserRole object is a mapping object that links a local user to their assigned roles and password within the context of an EndPointUserPolicy. P…
iam.EndPointUserRole.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointUserRoleInventory.Response
The response body of a HTTP GET request for the 'iam.EndPointUserRoleInventory' resource. The value may be one of the following types. 1. When 'tag' is specifi…
iam.EndPointUserRoleInventory.Relationship
A relationship to the 'iam.EndPointUserRoleInventory' resource, or the expanded 'iam.EndPointUserRoleInventory' resource, or the 'null' value.
iam.EndPointUserRoleInventory
The IAM EndPointUserRole object is a mapping object that links a local user to their assigned roles and password within the context of an EndPointUserPolicy. P…
iam.EndPointUserRoleInventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.FailureDetails
This has information including reason annd timestamp of failure event.
iam.FeatureDefinition
Feature parameters specified for the account.
iam.GroupPermissionToRoles
Complex type representing the associated resource groups, organizations and the permission to roles mapping.
iam.GuestAccessSettings.Response
The response body of a HTTP GET request for the 'iam.GuestAccessSettings' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iam.GuestAccessSettings
Stores account level settings for guest user access.
iam.GuestAccessSettings.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Idp.Response
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, t…
iam.Idp.Relationship
A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.
iam.Idp
The SAML identity provider such as Cisco, that has been used to log in to Intersight.
iam.Idp.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IdpReference.Response
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…
iam.IdpReference.Relationship
A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.
iam.IdpReference
The IdpReference object represents the system-provided Cisco IdP association within an account, acting as the default reference for user and group assignments.…
iam.IdpReference.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IpAccessManagement.Response
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 t…
iam.IpAccessManagement.Relationship
A relationship to the 'iam.IpAccessManagement' resource, or the expanded 'iam.IpAccessManagement' resource, or the 'null' value.
iam.IpAccessManagement
IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.…
iam.IpAccessManagement.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IpAddress.Response
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 qu…
iam.IpAddress.Relationship
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
iam.IpAddress
IpAddress represents a single allowlisted IP, CIDR block, or range used by IpAccessManagement. Purpose It models an individual entry in the IP access policy to…
iam.IpAddress.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapBaseProperties
Base settings of LDAP required while configuring LDAP policy.
iam.LdapConfigParams.Response
The response body of a HTTP GET request for the 'iam.LdapConfigParams' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iam.LdapConfigParams
LdapConfigParams stores additional configuration metadata used internally to support LDAP integration in appliance contexts. Purpose It centralizes internal pa…
iam.LdapConfigParams.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapDnsParameters
DNS settings used to access LDAP Providers.
iam.LdapGroup.Response
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 qu…
iam.LdapGroup.Relationship
A relationship to the 'iam.LdapGroup' resource, or the expanded 'iam.LdapGroup' resource, or the 'null' value.
iam.LdapGroup
The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint. Purpose The purpose is to grant per…
iam.LdapGroup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapGroupInventory.Response
The response body of a HTTP GET request for the 'iam.LdapGroupInventory' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
iam.LdapGroupInventory.Relationship
A relationship to the 'iam.LdapGroupInventory' resource, or the expanded 'iam.LdapGroupInventory' resource, or the 'null' value.
iam.LdapGroupInventory
The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint. Purpose The purpose is to grant per…
iam.LdapGroupInventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapMeta.Response
The response body of a HTTP GET request for the 'iam.LdapMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
iam.LdapMeta.Relationship
A relationship to the 'iam.LdapMeta' resource, or the expanded 'iam.LdapMeta' resource, or the 'null' value.
iam.LdapMeta
LdapMeta stores metadata for internal LDAP connectors created to support an appliance LDAP cluster configuration. Purpose It provides system-managed insight in…
iam.LdapMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapPolicy.Response
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 q…
iam.LdapPolicy.Relationship
A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.
iam.LdapPolicy
Overview The LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication…
iam.LdapPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapPolicyInventory.Response
The response body of a HTTP GET request for the 'iam.LdapPolicyInventory' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iam.LdapPolicyInventory.Relationship
A relationship to the 'iam.LdapPolicyInventory' resource, or the expanded 'iam.LdapPolicyInventory' resource, or the 'null' value.
iam.LdapPolicyInventory
Overview The LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication…
iam.LdapPolicyInventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapProvider.Response
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…
iam.LdapProvider.Relationship
A relationship to the 'iam.LdapProvider' resource, or the expanded 'iam.LdapProvider' resource, or the 'null' value.
iam.LdapProvider
Overview The LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy. Purpose The…
iam.LdapProvider.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapProviderInventory.Response
The response body of a HTTP GET request for the 'iam.LdapProviderInventory' resource. The value may be one of the following types. 1. When 'tag' is specified i…
iam.LdapProviderInventory.Relationship
A relationship to the 'iam.LdapProviderInventory' resource, or the expanded 'iam.LdapProviderInventory' resource, or the 'null' value.
iam.LdapProviderInventory
Overview The LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy. Purpose The…
iam.LdapProviderInventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LocalUserPassword.Response
The response body of a HTTP GET request for the 'iam.LocalUserPassword' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
iam.LocalUserPassword.Relationship
A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.
iam.LocalUserPassword
LocalUserPassword provides the mechanism for a local user to change their own password within the platform appliance context. This model is applicable only to…
iam.LocalUserPassword.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LocalUserPasswordPolicy.Response
The response body of a HTTP GET request for the 'iam.LocalUserPasswordPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified…
iam.LocalUserPasswordPolicy
LocalUserPasswordPolicy defines the password complexity and lockout policy for local users within an account. Purpose It establishes compliance and security re…
iam.LocalUserPasswordPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.OAuthToken.Response
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 q…
iam.OAuthToken.Relationship
A relationship to the 'iam.OAuthToken' resource, or the expanded 'iam.OAuthToken' resource, or the 'null' value.
iam.OAuthToken
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, expir…
iam.OAuthToken.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.OidcAuthTokenSet
Holds attributes obtained after OIDC authentication in plain text which are required for CUI admin portal MFE inside Intersight for IdP settings and routing ru…
iam.PasswordHistorySetting
Password history settings for endpoint users.
iam.PasswordHistorySettingCollection.Response
The response body of a HTTP GET request for the 'iam.PasswordHistorySettingCollection' resource. The value may be one of the following types. 1. When 'tag' is…
iam.PasswordHistorySettingCollection
The PasswordHistorySettingCollection object is a centralized management entity designed to track and enforce password history across the system. It addresses t…
iam.PasswordHistorySettingCollection.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Permission.Response
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 q…
iam.Permission.Relationship
A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.
iam.Permission
Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.
iam.Permission.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.PermissionReference
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 iden…
iam.PermissionToRoles
Complex type representing a permission and its associated roles.
iam.PrivateKeySpec.Response
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 U…
iam.PrivateKeySpec.Relationship
A relationship to the 'iam.PrivateKeySpec' resource, or the expanded 'iam.PrivateKeySpec' resource, or the 'null' value.
iam.PrivateKeySpec
PrivateKeySpec defines parameters for generating a private key that will be used to sign a certificate signing request (CSR). Purpose It standardizes the key g…
iam.PrivateKeySpec.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Privilege.Response
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 qu…
iam.Privilege.Relationship
A relationship to the 'iam.Privilege' resource, or the expanded 'iam.Privilege' resource, or the 'null' value.
iam.Privilege
Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.
iam.Privilege.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.PrivilegeSet.Response
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…
iam.PrivilegeSet.Relationship
A relationship to the 'iam.PrivilegeSet' resource, or the expanded 'iam.PrivilegeSet' resource, or the 'null' value.
iam.PrivilegeSet
A collection of privileges.
iam.PrivilegeSet.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.PrivilegeSetMetaInfo.Response
The response body of a HTTP GET request for the 'iam.PrivilegeSetMetaInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iam.PrivilegeSetMetaInfo
PrivilegeSetMetaInfo centralizes metadata to validate, relate, and maintain privilege sets. It captures the context needed to evaluate dependencies and associa…
iam.PrivilegeSetMetaInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Qualifier.Response
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 qu…
iam.Qualifier
The qualifier defines how a user qualifies to be part of a user group.
iam.Qualifier.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ResourceLimits.Response
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 U…
iam.ResourceLimits.Relationship
A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.
iam.ResourceLimits
ResourceLimits establishes account-level limits and policies for identity-related resources and credentials. Purpose It ensures controlled growth and predictab…
iam.ResourceLimits.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ResourcePermission.Response
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 t…
iam.ResourcePermission.Relationship
A relationship to the 'iam.ResourcePermission' resource, or the expanded 'iam.ResourcePermission' resource, or the 'null' value.
iam.ResourcePermission
ResourcePermission represents the permissions defined on a resource like organization.
iam.ResourcePermission.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ResourceRole
ResourceRoles provides a way to specify the roles associated with a resource like organization.
iam.ResourceRoles.Response
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 UR…
iam.ResourceRoles.Relationship
A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.
iam.ResourceRoles
ResourceRoles maps roles to a specific resource (e.g., an organization) within a permission, shaping the effective access model. Purpose It provides fine-grain…
iam.ResourceRoles.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Role.Response
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,…
iam.Role.Relationship
A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.
iam.Role
A role is a collection of privilege sets that are assigned to a user using a permission object.
iam.Role.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Rule
Rule stores the information about the IP address. This information is used during the IP address validation of the incoming request.
iam.SamlSpConnection
SamlSpConnection stores the metadata elements.
iam.SecurityContext
Complex type representing the access related properties of the requesting entity, required for authorization. Entity can be NB API user, a device, another micr…
iam.SecurityHolder.Response
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 U…
iam.SecurityHolder.Relationship
A relationship to the 'iam.SecurityHolder' resource, or the expanded 'iam.SecurityHolder' resource, or the 'null' value.
iam.SecurityHolder
SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource…
iam.SecurityHolder.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ServiceProvider.Response
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…
iam.ServiceProvider.Relationship
A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.
iam.ServiceProvider
ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs. Purpose It provides SP metad…
iam.ServiceProvider.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Session.Response
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 quer…
iam.Session.Relationship
A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.
iam.Session
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,…
iam.Session.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.SessionLimits.Response
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 UR…
iam.SessionLimits.Relationship
A relationship to the 'iam.SessionLimits' resource, or the expanded 'iam.SessionLimits' resource, or the 'null' value.
iam.SessionLimits
The session related configuration limits.
iam.SessionLimits.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.SharingRule.Response
The response body of a HTTP GET request for the 'iam.SharingRule' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
iam.SharingRule.Relationship
A relationship to the 'iam.SharingRule' resource, or the expanded 'iam.SharingRule' resource, or the 'null' value.
iam.SharingRule
SharingRule is a rule which signifies a Source Resource is shared with a Destination Resource. Source, Destination can be resources like Organization which are…
iam.SharingRule.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.SsoSessionAttributes
Session attributes required to maintain states of SP and IdP.
iam.SwitchAccountPermission
SwitchScope parameters related to the Account to/from which user switched.
iam.SwitchScopePermissions
SwitchScope parameters related to the Account to which user switched to.
iam.System.Response
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…
iam.System.Relationship
A relationship to the 'iam.System' resource, or the expanded 'iam.System' resource, or the 'null' value.
iam.System
The System object is the global root within the platform, serving as a container for objects that are shared across all accounts. It centralizes platform-wide…
iam.System.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.TenantLinking
Contains tenant linking information for CUI and CCC integration.
iam.TestIdpConfiguration.Response
The response body of a HTTP GET request for the 'iam.TestIdpConfiguration' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iam.TestIdpConfiguration.Relationship
A relationship to the 'iam.TestIdpConfiguration' resource, or the expanded 'iam.TestIdpConfiguration' resource, or the 'null' value.
iam.TestIdpConfiguration
TestIdpConfiguration supports validating an IdP setup by performing a controlled authentication, currently supported only for testing LDAP configurations. test…
iam.TestIdpConfiguration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.TrustPoint.Response
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 q…
iam.TrustPoint.Relationship
A relationship to the 'iam.TrustPoint' resource, or the expanded 'iam.TrustPoint' resource, or the 'null' value.
iam.TrustPoint
The TrustPoint object represents a trusted source of certificates within the system, enabling secure communication and authentication. Purpose A TrustPoint ser…
iam.TrustPoint.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.User.Response
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,…
iam.User.Relationship
A relationship to the 'iam.User' resource, or the expanded 'iam.User' resource, or the 'null' value.
iam.User
The User object represents individual users within the system, encompassing their identity, permissions, and roles. Purpose A User is a central entity within t…
iam.User.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.UserDetails
Holds information such as UserName and Email of a guest user logging in to the account.
iam.UserGroup.Response
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 qu…
iam.UserGroup.Relationship
A relationship to the 'iam.UserGroup' resource, or the expanded 'iam.UserGroup' resource, or the 'null' value.
iam.UserGroup
UserGroup provides a policy mechanism to assign permissions to cohorts of users based on identity attributes or explicit guest inclusion. Purpose UserGroup sim…
iam.UserGroup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.UserPreference.Response
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 U…
iam.UserPreference.Relationship
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
iam.UserPreference
UserPreference captures user interface preferences—such as layout, view state, or theme—persisted per user and identity context. Purpose It enables consistent,…
iam.UserPreference.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.UserQualifier.Response
The response body of a HTTP GET request for the 'iam.UserQualifier' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iam.UserQualifier
UserQualifier specifies explicit guest user lists for a guest-type UserGroup and supports notification flows. Purpose It streamlines management of guest access…
iam.UserQualifier.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.UserSetting.Response
The response body of a HTTP GET request for the 'iam.UserSetting' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
iam.UserSetting.Relationship
A relationship to the 'iam.UserSetting' resource, or the expanded 'iam.UserSetting' resource, or the 'null' value.
iam.UserSetting
UserSetting stores specific UI-related settings that are not part of general preferences, such as session recording opt-in status. Purpose It allows storing di…
iam.UserSetting.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.AccountLicenseData.Response
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…
license.AccountLicenseData.Relationship
A relationship to the 'license.AccountLicenseData' resource, or the expanded 'license.AccountLicenseData' resource, or the 'null' value.
license.AccountLicenseData
License information for an account.
license.AccountLicenseData.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.CustomerOp.Response
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 U…
license.CustomerOp.Relationship
A relationship to the 'license.CustomerOp' resource, or the expanded 'license.CustomerOp' resource, or the 'null' value.
license.CustomerOp
CustomerOp object is integral to managing customer operations related to license registration and authentication within the system. This provides mechanisms fo…
license.CustomerOp.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.ErpCustomerOp.Response
The response body of a HTTP GET request for the 'license.ErpCustomerOp' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
license.ErpCustomerOp.Relationship
A relationship to the 'license.ErpCustomerOp' resource, or the expanded 'license.ErpCustomerOp' resource, or the 'null' value.
license.ErpCustomerOp
The ErpCustomerOp object is crucial for managing operations related to ERP licensing, providing tools for trial enablement and administrative controls. Purpose…
license.ErpCustomerOp.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.ErpLicenseCount.Response
The response body of a HTTP GET request for the 'license.ErpLicenseCount' resource. The value may be one of the following types. 1. When 'tag' is specified in…
license.ErpLicenseCount.Relationship
A relationship to the 'license.ErpLicenseCount' resource, or the expanded 'license.ErpLicenseCount' resource, or the 'null' value.
license.ErpLicenseCount
Customer operation object to request reservation code.
license.ErpLicenseCount.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.IksCustomerOp.Response
The response body of a HTTP GET request for the 'license.IksCustomerOp' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
license.IksCustomerOp.Relationship
A relationship to the 'license.IksCustomerOp' resource, or the expanded 'license.IksCustomerOp' resource, or the 'null' value.
license.IksCustomerOp
The IksCustomerOp object handles customer operations related to the Intersight Kubernetes Service (IKS) licensing, providing mechanisms for trial enablement an…
license.IksCustomerOp.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.IksLicenseCount.Response
The response body of a HTTP GET request for the 'license.IksLicenseCount' resource. The value may be one of the following types. 1. When 'tag' is specified in…
license.IksLicenseCount.Relationship
A relationship to the 'license.IksLicenseCount' resource, or the expanded 'license.IksLicenseCount' resource, or the 'null' value.
license.IksLicenseCount
Customer operation object to request reservation code.
license.IksLicenseCount.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.IncCustomerOp.Response
The response body of a HTTP GET request for the 'license.IncCustomerOp' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
license.IncCustomerOp.Relationship
A relationship to the 'license.IncCustomerOp' resource, or the expanded 'license.IncCustomerOp' resource, or the 'null' value.
license.IncCustomerOp
The IncCustomerOp object is central to managing operations related to the Intersight Nexus Cloud (INC) licensing, offering functionalities for trial management…
license.IncCustomerOp.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.IncLicenseCount.Response
The response body of a HTTP GET request for the 'license.IncLicenseCount' resource. The value may be one of the following types. 1. When 'tag' is specified in…
license.IncLicenseCount.Relationship
A relationship to the 'license.IncLicenseCount' resource, or the expanded 'license.IncLicenseCount' resource, or the 'null' value.
license.IncLicenseCount
Customer operation object to request reservation code.
license.IncLicenseCount.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.IwoCustomerOp.Response
The response body of a HTTP GET request for the 'license.IwoCustomerOp' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
license.IwoCustomerOp.Relationship
A relationship to the 'license.IwoCustomerOp' resource, or the expanded 'license.IwoCustomerOp' resource, or the 'null' value.
license.IwoCustomerOp
The IwoCustomerOp object focuses on operations related to the Intersight Workload Optimizer (IWO) licensing, offering tools for managing license tiers and tria…
license.IwoCustomerOp.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.IwoLicenseCount.Response
The response body of a HTTP GET request for the 'license.IwoLicenseCount' resource. The value may be one of the following types. 1. When 'tag' is specified in…
license.IwoLicenseCount.Relationship
A relationship to the 'license.IwoLicenseCount' resource, or the expanded 'license.IwoLicenseCount' resource, or the 'null' value.
license.IwoLicenseCount
Customer operation object to request reservation code.
license.IwoLicenseCount.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.LicenseInfo.Response
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…
license.LicenseInfo.Relationship
A relationship to the 'license.LicenseInfo' resource, or the expanded 'license.LicenseInfo' resource, or the 'null' value.
license.LicenseInfo
License state information for a specific license entitlement. Essentials license entitlement is supported currently. licenseState attribute is used for license…
license.LicenseInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.LicenseInfoView.Response
The response body of a HTTP GET request for the 'license.LicenseInfoView' resource. The value may be one of the following types. 1. When 'tag' is specified in…
license.LicenseInfoView.Relationship
A relationship to the 'license.LicenseInfoView' resource, or the expanded 'license.LicenseInfoView' resource, or the 'null' value.
license.LicenseInfoView
The LicenseInfoView object provides a custom view for license information, designed to be displayed by user interfaces, enhancing user experience and informati…
license.LicenseInfoView.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.LicenseRegistrationStatus.Response
The response body of a HTTP GET request for the 'license.LicenseRegistrationStatus' resource. The value may be one of the following types. 1. When 'tag' is spe…
license.LicenseRegistrationStatus.Relationship
A relationship to the 'license.LicenseRegistrationStatus' resource, or the expanded 'license.LicenseRegistrationStatus' resource, or the 'null' value.
license.LicenseRegistrationStatus
The LicenseRegistrationStatus object is essential for monitoring the current step of license registration status, offering insights into registration flows and…
license.LicenseRegistrationStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.LicenseReservationOp.Response
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 specifie…
license.LicenseReservationOp
Customer operation object to request reservation code.
license.LicenseReservationOp.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.SmartlicenseToken.Response
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 i…
license.SmartlicenseToken.Relationship
A relationship to the 'license.SmartlicenseToken' resource, or the expanded 'license.SmartlicenseToken' resource, or the 'null' value.
license.SmartlicenseToken
The SmartlicenseToken object manages the collection of license registration tokens, ensuring secure and efficient handling of licensing credentials. Purpose Sm…
license.SmartlicenseToken.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
license.SubstituteLicense
License tiers can be substituted with higher tiers. Will contain information on the type of license being used for substitution, the number of substutions used…
meraki.Device.Response
The response body of a HTTP GET request for the 'meraki.Device' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
meraki.Device.Relationship
A relationship to the 'meraki.Device' resource, or the expanded 'meraki.Device' resource, or the 'null' value.
meraki.Device
A device belonging to a organization's network.
meraki.Device.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
meraki.Network.Response
The response body of a HTTP GET request for the 'meraki.Network' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
meraki.Network.Relationship
A relationship to the 'meraki.Network' resource, or the expanded 'meraki.Network' resource, or the 'null' value.
meraki.Network
A network belonging to an organization.
meraki.Network.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
meraki.Organization.Response
The response body of a HTTP GET request for the 'meraki.Organization' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
meraki.Organization.Relationship
A relationship to the 'meraki.Organization' resource, or the expanded 'meraki.Organization' resource, or the 'null' value.
meraki.Organization
Meraki organization which leverages Meraki's cloud-managed networking solutions to streamline and enhance its IT infrastructure.
meraki.Organization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
meraki.PortProfile.Response
The response body of a HTTP GET request for the 'meraki.PortProfile' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
meraki.PortProfile
A switch port configuration profile belonging to an organization.
meraki.PortProfile.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
meraki.Tag.Response
The response body of a HTTP GET request for the 'meraki.Tag' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
meraki.Tag
Tag on different meraki entities e.g. device, network and switch port.
meraki.Tag.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
meta.AccessPrivilege
The required access privilege for a given Managed Object and CRUD operation.
meta.Definition.Response
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…
meta.Definition
The meta-data of managed objects and complex types.
meta.Definition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
meta.DisplayNameDefinition
A rule for constructing user appropriate names for MO instances using the fields of the MO instance and MOs in its Ancestors hierarchy.
meta.IdentityDefinition
Definitions for the identity constraints in meta.
meta.PropDefinition
Definitions for the properties in a meta.
meta.RelationshipDefinition
Definitions for the relationship in a meta.
notification.AbstractAdvisoryFilter
Filter for a specific advisory type with selected severities and optional CVSS score filtering.
notification.AbstractCondition
AbstractCondition is a base abstract class for all types of conditions for notification.Subscription Mo. All conditions types inherit from this base type. It d…
notification.AbstractMoCondition
This condition type gives the ability to subscribe to the cond.Alarm ObjectType and provide a list of Severities you're interested in.
notification.AccountSubscription.Response
The response body of a HTTP GET request for the 'notification.AccountSubscription' resource. The value may be one of the following types. 1. When 'tag' is spec…
notification.AccountSubscription
The AccountSubscription object is a crucial component of the Intersight notification framework, designed to facilitate account-level subscriptions managed by A…
notification.AccountSubscription.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
notification.Action
Action abstract complex type describes the action the framework should perform when the event matched with a specific subscription is found. Ex.: Send Email, S…
notification.AdvisoryMoCondition
This condition type gives the ability to subscribe to the tam.AdvisoryInstance ObjectType and provide a list of Advisory Types you're interested in.
notification.AggregationSettings
Settings for events grouping.
notification.AlarmMoCondition
This condition type gives the ability to subscribe to the cond.Alarm ObjectType and provide a list of Severities you're interested in.
notification.ApplianceUpgradeMoCondition
This condition type gives the ability to subscribe to the appliance.Upgrade ObjectType and provide a list of Image statuses you're interested in.
notification.DistributableMoCondition
This condition type gives the ability to subscribe to the software.HyperflexBundleDistributable or firmware.Distributable or appliance.ApplianceDistributable o…
notification.EolAdvisoryFilter
Filter for a specific end-of-life advisory with selected severities.
notification.FieldNoticeAdvisoryFilter
Filter for a specific field notice advisory with selected severities.
notification.HttpHeader
HttpHeader represents a single HTTP header as a name/value pair. Used to specify custom headers that are attached to each webhook notification request. Exactly…
notification.MoCondition
This condition type gives the ability to subscribe to arbitrary MO type with arbitrary OData filter string and operation.
notification.SecurityAdvisoryFilter
Filter for a specific security advisory with selected severities.
notification.SendEmail
SendEmail complexType holds the recipient's email address.
notification.SimpleFilter
Single filter condition with an operator, property, and value. Used by notification SimpleMoCondition when a flat predicate is sufficient (not the shared filte…
notification.SimpleMoCondition
This condition type gives the ability to subscribe to arbitrary ObjectType with a controlled list of OData filter string and operation. Primarily used for emai…
notification.SoftwareReleaseMetaMoCondition
This condition type gives the ability to subscribe to the software.ReleaseMeta ObjectType and provide a list of ImageTypes you're interested in.
notification.Subscription
Subscription is the abstract model that holds shared properties for all subscription types. Different types of subscriptions extend this model and add their ow…
notification.TriggerWebhook
TriggerWebhook complexType holds the Payload URL's server meta info. Configure at most one primary signing or credential mechanism: secret (HMAC-SHA256), authe…
oauth.AccessToken.Response
The response body of a HTTP GET request for the 'oauth.AccessToken' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
oauth.AccessToken.Relationship
A relationship to the 'oauth.AccessToken' resource, or the expanded 'oauth.AccessToken' resource, or the 'null' value.
oauth.AccessToken
The AccessToken object is a key component of the OAuth-based authentication system, designed to manage API access tokens associated with user accounts. This pr…
oauth.AccessToken.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
oauth.Authorization.Response
The response body of a HTTP GET request for the 'oauth.Authorization' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
oauth.Authorization
The Authorization object underpins the OAuth2 authorization process, enabling user consent for external interactions on behalf of their account. It supports se…
oauth.Authorization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
openapi.ApiInfo
Meta information about the API that will be generated as task.
openapi.ApiMethodMeta.Response
The response body of a HTTP GET request for the 'openapi.ApiMethodMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
openapi.ApiMethodMeta
Contains metadata about APIs in the previously uploaded OpenAPI specification file.
openapi.ApiMethodMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
openapi.FailedTask
A type that holds information about failed tasks.
openapi.KeyValuePair
A key, value pair to hold different types of key, value information.
openapi.OpenApiSpecification.Response
The response body of a HTTP GET request for the 'openapi.OpenApiSpecification' resource. The value may be one of the following types. 1. When 'tag' is specifie…
openapi.OpenApiSpecification.Relationship
A relationship to the 'openapi.OpenApiSpecification' resource, or the expanded 'openapi.OpenApiSpecification' resource, or the 'null' value.
openapi.OpenApiSpecification
An OpenAPI specification file uploaded to generate workflow tasks.
openapi.OpenApiSpecification.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
openapi.ProcessFile.Response
The response body of a HTTP GET request for the 'openapi.ProcessFile' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
openapi.ProcessFile.Relationship
A relationship to the 'openapi.ProcessFile' resource, or the expanded 'openapi.ProcessFile' resource, or the 'null' value.
openapi.ProcessFile
Validates the OpenAPI specification file. On successful validation, it persists information about the available APIs. This information can be used to create ta…
openapi.ProcessFile.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
openapi.TaskGenerationRequest.Response
The response body of a HTTP GET request for the 'openapi.TaskGenerationRequest' resource. The value may be one of the following types. 1. When 'tag' is specifi…
openapi.TaskGenerationRequest.Relationship
A relationship to the 'openapi.TaskGenerationRequest' resource, or the expanded 'openapi.TaskGenerationRequest' resource, or the 'null' value.
openapi.TaskGenerationRequest
Creates a request which has information about the tasks that need to be created from the previously uploaded OpenAPI specification file. This object internally…
openapi.TaskGenerationRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
openapi.TaskGenerationResult.Response
The response body of a HTTP GET request for the 'openapi.TaskGenerationResult' resource. The value may be one of the following types. 1. When 'tag' is specifie…
openapi.TaskGenerationResult
Provides information about the status of the tasks created for a TaskGenerationRequest.
openapi.TaskGenerationResult.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
oprs.Deployment.Response
The response body of a HTTP GET request for the 'oprs.Deployment' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
oprs.Deployment
The Deployment object monitors the status of operators deployed within the assist environment. This provides insights into the operational health and configura…
oprs.Deployment.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
oprs.Kvpair
A simple key value pair type.
oprs.SyncTargetListMessage.Response
The response body of a HTTP GET request for the 'oprs.SyncTargetListMessage' resource. The value may be one of the following types. 1. When 'tag' is specified…
oprs.SyncTargetListMessage
The SyncTargetListMessage object manages the synchronization of target lists between assist environments and Euclid for reconciliation purposes. It ensures con…
oprs.SyncTargetListMessage.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
organization.Organization.Response
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 i…
organization.Organization.Relationship
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
organization.Organization
Organization provides multi-tenancy within an account. Multiple organizations can be present under an account. Resources are associated to organization using r…
organization.Organization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.AbstractReservation
You can reserve resources for use cases related to Pools or Groups. For example, resources that are decommissioned or reserved for future allocation are mainta…
resource.AbstractResourceQualificationPolicy.Relationship
A relationship to the 'resource.AbstractResourceQualificationPolicy' resource, or the expanded 'resource.AbstractResourceQualificationPolicy' resource, or the…
resource.AbstractResourceQualificationPolicy
The base QualificationPolicy extends from AbstractPolicy; all qualification policies will be derived from this class. For example, ServerPoolQualificationPolic…
resource.AdaptorsRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum adaptors value.
resource.AdvancedFilter
Advanced filter property holder.
resource.BladeQualifier
The BladeQualifier object is focused on qualifying blade servers based on various chassis and slot properties. It extends the ServerQualifier, offering detaile…
resource.ChassisAndSlotQualification
The server is qualified based on the chassis ID and slot ID. For example, if the conditions are such that ChassisId is in the range of 1-4 and SlotIds are in t…
resource.ChassisIdRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum value.
resource.ChassisServersQualifier
Resources are added to the pool based on characteristics of servers like slotId of server connected to chassis.
resource.CpuCoreRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum CPU core value.
resource.CpuSpeedRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum CPU speed value.
resource.DomainQualifier
The DomainQualifier object is designed to qualify or filter servers based on domain-specific properties. It extends the ResourceQualifier, allowing more precis…
resource.GpuControllersRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum GPU controller value.
resource.GpuQualifier
The GpuQualifier object focuses on qualifying resources based on GPU characteristics. It extends the HardwareQualifier, providing criteria for resource selecti…
resource.Group.Response
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 q…
resource.Group.Relationship
A relationship to the 'resource.Group' resource, or the expanded 'resource.Group' resource, or the 'null' value.
resource.Group
The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings. Purpose A…
resource.Group.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.GroupMember.Response
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…
resource.GroupMember
The GroupMember object identifies resolved members within a resource group, providing clarity and organization to resource membership management. Purpose A Gro…
resource.GroupMember.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.HardwareQualifier
The server is filtered into the pool based on specific conditions. The hardware qualifier serves as the base class for memory qualifier, processor qualifier, G…
resource.LicenseResourceCount.Response
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 specifi…
resource.LicenseResourceCount
The LicenseResourceCount object tracks the number of resources associated with different licensing tiers, aiding in licensing management and resource allocatio…
resource.LicenseResourceCount.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.Membership.Response
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…
resource.Membership
ResourceMembership represents a resource's associated groups, organizations and the permissions associated to this resource via organizations.
resource.Membership.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.MembershipHolder.Response
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 i…
resource.MembershipHolder.Relationship
A relationship to the 'resource.MembershipHolder' resource, or the expanded 'resource.MembershipHolder' resource, or the 'null' value.
resource.MembershipHolder
The MembershipHolder object acts as a container for REST resources and their membership within the system. It plays a crucial role in managing and organizing r…
resource.MembershipHolder.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.MemoryCapacityRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum memory capacity value.
resource.MemoryQualifier
The MemoryQualifier object is dedicated to qualifying resources based on memory characteristics. It extends the HardwareQualifier, providing specialized criter…
resource.MemoryUnitsRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum memory unit value.
resource.NetworkAdaptorQualifier
The NetworkAdaptorQualifier object is designed to qualify resources based on network adaptor characteristics. It extends the HardwareQualifier, providing speci…
resource.OdataRuleSetQualifier
Resources are added to the pool based on OData filter conditions.
resource.PerTypeCombinedSelector
Complex type representing an object type to associated filter by combining all selectors.
resource.ProcessorQualifier
The ProcessorQualifier object is intended to qualify resources based on processor characteristics. It extends the HardwareQualifier, offering detailed criteria…
resource.RackIdRangeFilter
The RackIdRangeFilter object is intended to define qualification criteria based on rack ID ranges. It is a concrete implementation of the RangeFilter, providin…
resource.RackServerQualifier
The rack servers are qualified for the pool based on properties of RackServer, such as RackId, RackPID, etc., which are captured as part of the RackServerQuali…
resource.RangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum value.
resource.Reservation.Response
The response body of a HTTP GET request for the 'resource.Reservation' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
resource.Reservation.Relationship
A relationship to the 'resource.Reservation' resource, or the expanded 'resource.Reservation' resource, or the 'null' value.
resource.Reservation
The Reservation object is responsible for reserving slots for new resources within resource groups, ensuring organized and planned resource allocation. Purpose…
resource.Reservation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.ResourceQualifier
The resources are matched with multiple qualifiers; ResourceQualifier is the base class for all qualifiers.
resource.RuleSetQualifier
Determines whether resources qualify for inclusion in a pool based on a set of rules.
resource.SelectionCriteria.Response
The response body of a HTTP GET request for the 'resource.SelectionCriteria' resource. The value may be one of the following types. 1. When 'tag' is specified…
resource.SelectionCriteria
The SelectionCriteria object enables the selection of resources based on specific criteria, providing flexibility and precision in resource management. Purpose…
resource.SelectionCriteria.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.Selector
Complex type representing the filter condition to extract the resources.
resource.ServerQualifier
The server is filtered into the pool based on specific conditions. The server qualifier serves as the base class for RackServer and BladeQualifier, holding com…
resource.SharedResourcesInfoHolder.Response
The response body of a HTTP GET request for the 'resource.SharedResourcesInfoHolder' resource. The value may be one of the following types. 1. When 'tag' is sp…
resource.SharedResourcesInfoHolder
The SharedResourcesInfoHolder object manages holds shared resource configurations within the system, facilitating resource sharing and collaboration. Purpose S…
resource.SharedResourcesInfoHolder.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.SlotIdRangeFilter
Consist of two boundaries that define the range, namely the minimum and the maximum SlotId value.
resource.SourceToPermissionResources
SourceToPermissionResources holds the source and the permissionResources belonging to them.
resource.SourceToPermissionResourcesHolder
The holder which holds the multiple custom permission sources and the permissionResources belonging to the sources. These permissionResources are added to the…
resource.Tag
The Tag object represents a key-value pair used for resource filtering based on user-defined criteria. It functions as a concrete element within the qualificat…
resource.TagQualifier
The resource is qualified based on user tags at various types, such as Domain, Chassis, Blade, Rack, etc. The filtering of resources is determined by matching…
servicenow.ChangeRequest.Response
The response body of a HTTP GET request for the 'servicenow.ChangeRequest' resource. The value may be one of the following types. 1. When 'tag' is specified in…
servicenow.ChangeRequest
The ChangeRequest object is a core component of the ServiceNow integration framework, designed to manage and document change requests within the ServiceNow sys…
servicenow.ChangeRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
servicenow.ChangeRequestDoc.Response
The response body of a HTTP GET request for the 'servicenow.ChangeRequestDoc' resource. The value may be one of the following types. 1. When 'tag' is specified…
servicenow.ChangeRequestDoc
The ChangeRequestDoc object is part of the ServiceNow service, providing a schema for change request documentation. It offers a structured approach to document…
servicenow.ChangeRequestDoc.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
servicenow.Incident.Response
The response body of a HTTP GET request for the 'servicenow.Incident' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
servicenow.Incident
The Incident object is an integral part of the ServiceNow service, designed to manage incidents and ensure their timely resolution. This provides a standardize…
servicenow.Incident.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
servicenow.IncidentDoc.Response
The response body of a HTTP GET request for the 'servicenow.IncidentDoc' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
servicenow.IncidentDoc
The IncidentDoc object is part of the ServiceNow service, providing a schema for incident-related documentation. It serves as a foundational element for struct…
servicenow.IncidentDoc.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
servicenow.InventoryEntity
Base object type for all ServiceNow Inventory items.
task.CatalystSdwanScopedInventory
CatalystSdwanScopedInventories represent an on-demand inventory trigger used to refresh inventory for a specific registered Catalyst SD-WAN device/connection.…
task.FabricMosScopedInventory
API to trigger on-demand inventory to update MDS objects in Intersight.
task.HciScopedInventory
The HciScopedInventory object is a trigger for on-demand inventory collection for the specified set of managed objects. Purpose The HciScopedInventory object f…
task.HitachiScopedInventory
The HitachiScopedInventory object provides an API to trigger on-demand HitachiStorage FlashArray inventory updates, supporting effective storage system reporti…
task.HyperFlexManagementScopedInventory
HyperFlexManagementScopedInventories are task-trigger objects used to initiate an on-demand HyperFlex inventory collection for a specific registered HyperFlex…
task.HyperflexScopedInventory
API to trigger on-demand Hyperflex Cluster inventory to update modified objects in Intersight report.
task.MdsScopedInventory
API to trigger on-demand MDS inventory to update modified objects in Intersight report.
task.MdsSystemScopedInventory
API to trigger on-demand MDS System inventory after the workflow execution.
task.MerakiScopedInventory
API to trigger on-demand inventory to update modified objects.
task.NetAppScopedInventory
API to trigger on-demand NetAppStorage inventory to update modified objects in Intersight report.
task.NexusScopedInventory
API to trigger on-demand Nexus inventory to update modified objects in Intersight report.
task.NexusSystemScopedInventory
API to trigger on-demand Nexus SNMP inventory to update modified objects in Intersight report.
task.NexusVlanScopedInventory
API to trigger on-demand Nexus VLAN inventory to update modified objects in Intersight report.
task.PureFlashBladeScopedInventory
The PureFlashBladeScopedInventory object provides on-demand inventory management for FlashBlade storage arrays, enabling dynamic updates to managed objects fol…
task.PureScopedInventory
API to trigger on-demand PureStorage FlashArray inventory to update modified objects in Intersight report.
task.ServerScopedInventory
API to trigger on-demand Server inventory to update modified objects in Intersight report.
ucsd.BackupInfo.Response
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…
ucsd.BackupInfo
The BackupInfo object provides detailed insights into backup images available for restoration on target endpoint (UCS Director) devices. It captures essential…
ucsd.BackupInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
ucsd.ConnectorPack
Connector pack details from the backup file.
ucsd.UcsdRestoreParameters
UCS director restore workflow configuration parameters.
webhook.Endpoint.Response
The response body of a HTTP GET request for the 'webhook.Endpoint' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
webhook.Endpoint
The Endpoint object is a crucial component for managing webhook communications within the system. Endpoint provides a structured approach for controllers to fo…
webhook.Endpoint.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
webhook.Schema.Response
The response body of a HTTP GET request for the 'webhook.Schema' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
webhook.Schema.Relationship
A relationship to the 'webhook.Schema' resource, or the expanded 'webhook.Schema' resource, or the 'null' value.
webhook.Schema
The Schema object is integral to event management, providing the framework that defines the structure of events. It ensures consistency and validity in the way…
webhook.Schema.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.AbstractLoopTask
An abstract loop task which is used to model different types of loops like serial and parallel.
workflow.AbstractResourceSelector
The abstract selector which can be used to create selection criteria for inputs.
workflow.AbstractWorkerTask
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.
workflow.AnsibleBatchExecutor.Response
The response body of a HTTP GET request for the 'workflow.AnsibleBatchExecutor' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.AnsibleBatchExecutor
The AnsibleBatchExecutor object is a core component within Intersight's workflow framework, designed to facilitate the execution of Ansible commands in batch m…
workflow.AnsibleBatchExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.AnsiblePlaySession
This models a single Ansible playbook execution session on the Ansible Control node. While execution of the respective Ansible task, the below provided propert…
workflow.Api
Intersight Orchestrator supports generic API workflow tasks that can execute an API given the request body and response parser specification. API type models a…
workflow.ArrayDataType
This data type represents an array of a given type. It can be an array of primitive data or of custom data.
workflow.ArrayItem
ArrayItem represents an array item within the array.
workflow.AssociatedRoles
AssociatedRoles models the inferred tasks to the required roles mapping cached in the workflow definition.
workflow.BaseDataType
The base data type that is used to derive all the other data types for inputs and outputs.
workflow.BaseOperation
Specify operation type on a service item like deployment or post-deployment to be performed on catalog.
workflow.BaseServiceItemActionProperty
BaseServiceItemActionProperty is the abstract definition to capture the properties in ServiceItemActionProperties.
workflow.BatchApiExecutor.Response
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 i…
workflow.BatchApiExecutor
The BatchApiExecutor object is a key component within the workflow system that facilitates the execution of multiple API requests as part of a single task exec…
workflow.BatchApiExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.BatchExecutor
Intersight support for creating generic API tasks using the API request body and a response parser specification in the form of a content.Grammar object. The B…
workflow.CancelableType
Defines the conditions under which a workflow can be canceled.
workflow.Catalog.Response
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…
workflow.Catalog.Relationship
A relationship to the 'workflow.Catalog' resource, or the expanded 'workflow.Catalog' resource, or the 'null' value.
workflow.Catalog
The Catalog object serves as a container for organizing definitions related to orchestration, including both workflow, task definitions and more. Purpose It pr…
workflow.Catalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CatalogItemDefinition.Response
The response body of a HTTP GET request for the 'workflow.CatalogItemDefinition' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.CatalogItemDefinition.Relationship
A relationship to the 'workflow.CatalogItemDefinition' resource, or the expanded 'workflow.CatalogItemDefinition' resource, or the 'null' value.
workflow.CatalogItemDefinition
Catalog Item definition is a collection of Service items which are associated with workflow definition that can be used to deploy and manage service items.
workflow.CatalogItemDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CatalogServiceRequest.Response
The response body of a HTTP GET request for the 'workflow.CatalogServiceRequest' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.CatalogServiceRequest.Relationship
A relationship to the 'workflow.CatalogServiceRequest' resource, or the expanded 'workflow.CatalogServiceRequest' resource, or the 'null' value.
workflow.CatalogServiceRequest
Catalog Service Request is one instance of a catalog item based on a catalog item definition.
workflow.CatalogServiceRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CliCommand
This models a single CLI command that can be executed on the end point.
workflow.Comments
Contains detailed information about template function.
workflow.Constraints
Captures the constraints for valid parameter values.
workflow.ControlTask
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.
workflow.CustomArrayItem
Captures an array of custom datatype items.
workflow.CustomDataProperty
Capture all the properties for Custom data type.
workflow.CustomDataType
This data type represents a custom data object.
workflow.CustomDataTypeDefinition.Response
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 spe…
workflow.CustomDataTypeDefinition.Relationship
A relationship to the 'workflow.CustomDataTypeDefinition' resource, or the expanded 'workflow.CustomDataTypeDefinition' resource, or the 'null' value.
workflow.CustomDataTypeDefinition
The CustomDataTypeDefinition object provides a framework for defining customized data types used within workflows, enhancing flexibility and reusability. Purpo…
workflow.CustomDataTypeDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CustomDataTypeProperties
Properties for a custom data type definition.
workflow.DataSourceSelector
An alternative selector to MoReferenceProperty that serves as a data source for PrimitiveDataTypes. It supports selecting data from workflow execution sources,…
workflow.DecisionCase
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.
workflow.DecisionTask
A DecisionTask is a control task that executes a sequence of WorkflowTasks based off decision provided and evaluated by this task.
workflow.DefaultValue
Captures default vales for a data type.
workflow.DisplayMeta
Captures the meta data needed for displaying workflow data types in Intersight User Interface.
workflow.DynamicTemplateParserDataType
Data type to fetch a generic template from given selector and parse it using an api to give an array of secure and non-secure keys for form generation. URL use…
workflow.EndTask
An EndTask denotes the completion of a workflow.
workflow.EnumEntry
Captures a single enum entry which has a label and value.
workflow.EnvironmentVariableReference
Holds environment variables references.
workflow.ErrorResponseHandler.Response
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 specifi…
workflow.ErrorResponseHandler.Relationship
A relationship to the 'workflow.ErrorResponseHandler' resource, or the expanded 'workflow.ErrorResponseHandler' resource, or the 'null' value.
workflow.ErrorResponseHandler
The ErrorResponseHandler object is designed to manage error responses within the workflow system. This provides a standardized way to define error response spe…
workflow.ErrorResponseHandler.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ExpectPrompt
This models a single expect and answer prompt of the interactive command.
workflow.FailureEndTask
A FailureEndTask denotes the failed completion of a workflow.
workflow.FileDownloadOp
File operation to download a given file from Intersight storage services such as AWS or Minio bucket to a specified path on one or more Intersight connected de…
workflow.FileOperations
This models a single File Operation request within a batch of requests that get executed within a single workflow task.
workflow.FileTemplateOp
Populates data driven template file with input values to generate textual output.
workflow.FileTransfer
Message to transfer a file from Intersight connected device to remote server.
workflow.ForkTask
A ForkTask is a control task that forks tasks for parallel execution in a workflow.
workflow.InitiatorContext
Details about the workflow initiator name, type, initiator object Id if present and the result handler.
workflow.InternalProperties
Internal properties for a task definition which are not editable by the user.
workflow.JoinTask
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 tas…
workflow.LoopTask
A Parallel Loop is a control task that runs one task or one sub-workflow multiple times based on a specified count. The count can be a static value that is spe…
workflow.Message
Intermediate Task or Workflow message with severity.
workflow.MigrateServiceItemActionProperty
Definition to capture the properties for migrate action in ServiceItemActionProperties.
workflow.MigrationHistory
Migration history of versions for service item instance.
workflow.MoInventoryDataType
The data type to represent the selected properties of an Intersight managed object. This data type is used only in Service items to define the schema of resour…
workflow.MoInventoryProperty
Captures the properties from the original Intersight resource that need to be reflected in the datatype.
workflow.MoReferenceArrayItem
MoReferenceArrayItem is used to create an array of MoReference datatype.
workflow.MoReferenceAutoArrayItem
MoReferenceAutoArrayItem is used to create an array of MoReferenceAuto datatype.
workflow.MoReferenceAutoDataType
The data type to capture an Intersight managed object reference that is automatically selected by the system based on a given selection criteria.
workflow.MoReferenceAutoProperty
Captures all the display attributes and rules for selecting the resources.
workflow.MoReferenceDataType
Data type to capture an Intersight Managed object reference.
workflow.MoReferenceForCloneDataType
Data type captures a reference to an Intersight Managed Object (MO) that serves as the source for cloning and creating an input object. The fields to be passed…
workflow.MoReferenceProperty
Capture all the properties for an Intersight managed object reference.
workflow.OperationTypeDecommission
Operation details for decommission actions.
workflow.OperationTypeDeployment
Definition to capture the operation details for deployment actions.
workflow.OperationTypePostDeployment
Operation details for post-deployment actions.
workflow.ParameterSet
The parameter set is a rule with a condition to match the controlling parameter against a value and make a set of parameters applicable.
workflow.PowerShellApi
This models a single PowerShell script execution that can be sent to a claimed PowerShell target.
workflow.PowerShellBatchApiExecutor.Response
The response body of a HTTP GET request for the 'workflow.PowerShellBatchApiExecutor' resource. The value may be one of the following types. 1. When 'tag' is s…
workflow.PowerShellBatchApiExecutor
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. Bat…
workflow.PowerShellBatchApiExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.PrimitiveArrayItem
PrimitiveArrayItem is used to create an array of primitive datatype. In order to create an array of strings, integers or float use PrimitiveArrayItem object ty…
workflow.PrimitiveDataProperty
Capture all the properties for primitive data type.
workflow.PrimitiveDataType
This data type is used to represent primitives like string, floats and integers.
workflow.Properties
Properties for the task definition like the inputs, outputs, timeout and retry policies. Tasks are the building blocks for workflows.
workflow.ResourceInlineSelector
The resource selection inline conditions can be represented using InlineSelector.
workflow.ResourceSelectorCriteria
The resource selector holds one or more Resource Selection conditions and the runtime parameters.
workflow.ResultHandler
The task result handler service details. It will be executed once the workflow reaches terminal state.
workflow.RollbackTask
Rollback task mapping information.
workflow.RollbackWorkflow.Response
The response body of a HTTP GET request for the 'workflow.RollbackWorkflow' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.RollbackWorkflow
The RollbackWorkflow object addresses the management and execution of rollback operations within the workflow system. This provides a structured approach to re…
workflow.RollbackWorkflow.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.RollbackWorkflowTask
Rollback workflow task information.
workflow.SelectorProperty
Selector properties to define HTTP method and 'body' in case of upsert (short for update or insert) operations. When requested resource (endpoint) does not exi…
workflow.SequenceParams
Parameters to capture information required to sequence the workflows.
workflow.SerialLoopTask
A Serial Loop is a control task that runs one or more worker tasks multiple times based on a specified count or a given condition. Either count or condition mu…
workflow.ServiceItemActionDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemActionDefinition' resource. The value may be one of the following types. 1. When 'tag' is…
workflow.ServiceItemActionDefinition.Relationship
A relationship to the 'workflow.ServiceItemActionDefinition' resource, or the expanded 'workflow.ServiceItemActionDefinition' resource, or the 'null' value.
workflow.ServiceItemActionDefinition
Definition to capture the details needed to execute an action on the service item.
workflow.ServiceItemActionDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemActionInstance.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemActionInstance' resource. The value may be one of the following types. 1. When 'tag' is sp…
workflow.ServiceItemActionInstance.Relationship
A relationship to the 'workflow.ServiceItemActionInstance' resource, or the expanded 'workflow.ServiceItemActionInstance' resource, or the 'null' value.
workflow.ServiceItemActionInstance
Service item action instance which represents one action on a service item instance.
workflow.ServiceItemActionInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemActionProperties
Definition to capture the action properties which will be used in the action of service item.
workflow.ServiceItemActionWorkflowDefinition
Definition to capture the workflow definition which will be used in the action of a service item definition.
workflow.ServiceItemAttribute.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemAttribute' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.ServiceItemAttribute
Service item attribute which represents all the artifacts created or related to this service item instance.
workflow.ServiceItemAttribute.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemDefinition' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.ServiceItemDefinition.Relationship
A relationship to the 'workflow.ServiceItemDefinition' resource, or the expanded 'workflow.ServiceItemDefinition' resource, or the 'null' value.
workflow.ServiceItemDefinition
Service Item definition is a collection of actions and associated workflow definition that can be used to deploy a service item.
workflow.ServiceItemDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemHealthCheckDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemHealthCheckDefinition' resource. The value may be one of the following types. 1. When 'tag…
workflow.ServiceItemHealthCheckDefinition.Relationship
A relationship to the 'workflow.ServiceItemHealthCheckDefinition' resource, or the expanded 'workflow.ServiceItemHealthCheckDefinition' resource, or the 'null'…
workflow.ServiceItemHealthCheckDefinition
Service item health check definition metadata.
workflow.ServiceItemHealthCheckDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemHealthCheckExecution.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemHealthCheckExecution' resource. The value may be one of the following types. 1. When 'tag'…
workflow.ServiceItemHealthCheckExecution
Health check execution result for a health check definition on a service item.
workflow.ServiceItemHealthCheckExecution.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemInputDefinitionType
Definition to capture the inputs for a service items included inside a catalog. It captures the input definition and the associated input parameter mappings fo…
workflow.ServiceItemInstance.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemInstance' resource. The value may be one of the following types. 1. When 'tag' is specifie…
workflow.ServiceItemInstance.Relationship
A relationship to the 'workflow.ServiceItemInstance' resource, or the expanded 'workflow.ServiceItemInstance' resource, or the 'null' value.
workflow.ServiceItemInstance
Service item instance is one instance of a service item based on a service item definition.
workflow.ServiceItemInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemOutput.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemOutput' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.ServiceItemOutput
Service item output which represents all the artifacts created or related to this service item instance.
workflow.ServiceItemOutput.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemType
Definition to capture the service items associated with the catalog.
workflow.SshBatchExecutor.Response
The response body of a HTTP GET request for the 'workflow.SshBatchExecutor' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.SshBatchExecutor
The SshBatchExecutor object is a core component of Intersight’s workflow system, specialized in handling the batch execution of SSH commands. It is designed to…
workflow.SshBatchExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.SshCmd
SSH command to execute on the remote server.
workflow.SshConfig
Carries the SSH session details for opening a new connection.
workflow.SshSession
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 sessi…
workflow.StartTask
A StartTask is the starting point for a workflow. There can only be one StartTask in a workflow.
workflow.SubWorkflowTask
A SubWorkflowTask is used to include another workflow as a task within this workflow.
workflow.SuccessEndTask
A SuccessEndTask denotes the successful completion of a workflow.
workflow.TargetContext
Target context holds information about the Intersight managed object on which the workflow is executing and hence the entity that is being affected by the work…
workflow.TargetDataType
Data type to capture a target endpoint or device.
workflow.TargetProperty
Capture all the properties for an input target endpoint or device.
workflow.TaskConstraints
Captures the constraints for a task. Currently, it hold only targetDataType constraints such as Vendor, ObjectType that are properties of a target device.
workflow.TaskDebugLog.Response
The response body of a HTTP GET request for the 'workflow.TaskDebugLog' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.TaskDebugLog
The TaskDebugLog object provides detailed debugging information for task execution within workflows. It serves as a critical tool for isolating and resolving t…
workflow.TaskDebugLog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskDefinition.Response
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…
workflow.TaskDefinition.Relationship
A relationship to the 'workflow.TaskDefinition' resource, or the expanded 'workflow.TaskDefinition' resource, or the 'null' value.
workflow.TaskDefinition
The TaskDefinition object is a foundational element of the workflow system, designed to define individual tasks that can be orchestrated within a workflow. It…
workflow.TaskDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskInfo.Response
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 UR…
workflow.TaskInfo.Relationship
A relationship to the 'workflow.TaskInfo' resource, or the expanded 'workflow.TaskInfo' resource, or the 'null' value.
workflow.TaskInfo
The TaskInfos object represents the runtime instance of a task executing within a workflow. Purpose It tracks the execution lifecycle of a specific task instan…
workflow.TaskInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskInfoUpdate
TaskInfoUpdate is used to capture the updates that are required for the task instance inside an executing workflow. WaitTask, included inside the workflow, can…
workflow.TaskLoopInfo
Keep track of loop information for every task executed inside the loop.
workflow.TaskMetadata.Response
The response body of a HTTP GET request for the 'workflow.TaskMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.TaskMetadata.Relationship
A relationship to the 'workflow.TaskMetadata' resource, or the expanded 'workflow.TaskMetadata' resource, or the 'null' value.
workflow.TaskMetadata
Task details is a collection of properties that are common across all the versions of a task.
workflow.TaskMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskRetryInfo
Keep track of task retry information using TaskRetryInfo.
workflow.TemplateEvaluation
The TemplateEvaluation object focuses on the execution and evaluation of templates within the workflow system. This provides mechanisms to dynamically generate…
workflow.TemplateFunctionMeta.Response
The response body of a HTTP GET request for the 'workflow.TemplateFunctionMeta' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.TemplateFunctionMeta
The TemplateFunctionMeta object is a key component within the workflow system, designed to encapsulate the metadata and functionality of template functions. Pu…
workflow.TemplateFunctionMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TemplateParser
The TemplateParser object is designed to parse templates and extract placeholders within the workflow system. It plays a crucial role in template management an…
workflow.UiDisplayMetadata.Response
The response body of a HTTP GET request for the 'workflow.UiDisplayMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.UiDisplayMetadata
The UiDisplayMetadata object captures the visual layout metadata for user interfaces in workflow systems. It focuses on defining form and view layouts, contrib…
workflow.UiDisplayMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.UiFormConfig
Contains metadata which specify the UI form layout for data. The type, schema of the data comes from the datatype definition and only the visual form layout is…
workflow.UiInputFilter
A cascade filter enables the definition or extension of an optional filter for Intersight APIs, to narrow down the search results. This can be defined for work…
workflow.UiViewConfig
Contains metadata which specify the UI view config for data. The type, schema of the data comes from the datatype definition and only the visual layout of data…
workflow.ValidationError
Used to show validation errors for the workflow or for the task within the workflow.
workflow.ValidationInformation
Type used to capture all the validation information for the workflow definition.
workflow.Variable.Response
The response body of a HTTP GET request for the 'workflow.Variable' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
workflow.Variable
The Variable object facilitates the management of user-defined entities within workflows, allowing for consistent and reusable data references across different…
workflow.Variable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WaitTask
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 tas…
workflow.WaitTaskPrompt
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 wor…
workflow.WebApi
This models a single Web API request within a batch of requests that get executed within a single workflow task.
workflow.WorkerTask
A WorkerTask is a simple task and the smallest granularity of work that can be defined as a task.
workflow.WorkflowCtx
The workflow context contains initiator and target information along with workflow type and action information.
workflow.WorkflowDefinition.Response
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…
workflow.WorkflowDefinition.Relationship
A relationship to the 'workflow.WorkflowDefinition' resource, or the expanded 'workflow.WorkflowDefinition' resource, or the 'null' value.
workflow.WorkflowDefinition
The WorkflowDefinitions object serves as the blueprint for automation, representing a collection of tasks sequenced as a Directed Acyclic Graph (DAG). Purpose…
workflow.WorkflowDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowEngineProperties
Properties for performing workflow action on workflow engine.
workflow.WorkflowInfo.Response
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 th…
workflow.WorkflowInfo.Relationship
A relationship to the 'workflow.WorkflowInfo' resource, or the expanded 'workflow.WorkflowInfo' resource, or the 'null' value.
workflow.WorkflowInfo
The WorkflowInfo object encapsulates the execution instance of a workflow, providing details about its progress, state, and execution context. It is essential…
workflow.WorkflowInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowInfoAutoRestartProperties
Properties for auto-restarting a failed workflow execution. Workflow will be auto-restarted from the beginning upon failure when the autorestart property is se…
workflow.WorkflowInfoProperties
Properties for a workflowInfo.
workflow.WorkflowMetadata.Response
The response body of a HTTP GET request for the 'workflow.WorkflowMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.WorkflowMetadata.Relationship
A relationship to the 'workflow.WorkflowMetadata' resource, or the expanded 'workflow.WorkflowMetadata' resource, or the 'null' value.
workflow.WorkflowMetadata
Workflow metadata is a collection of properties that are common across all the versions of a workflow.
workflow.WorkflowMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowProperties
Properties for a workflow definition.
workflow.WorkflowTask
Task instance within the workflow to be executed.
workflow.XmlApi
This models a single XML API request that can be sent to any Cisco UCS devices that support Cisco UCS XML API interface.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Intersight publishes across the network.