The identity and technical contract details declared by the specification.
telemetry.DruidBaseRequest
object
The base structure for all Druid requests.
1 property
1 required
telemetry.DruidError
object
The error response when a Druid query fails.
3 properties
telemetry.DruidIntervalResult
object
The time series results for a particular interval
2 properties
telemetry.DruidTopNResult
object
Sorted time series results for a particular interval based on some criteria
2 properties
telemetry.DruidGroupByResult
object
A time series result based on a provided groupBy query. Result can contain multiple dimensions and values.
3 properties
telemetry.DruidScanResult
object
Druid Scan row result.
3 properties
telemetry.DruidSearchResult
object
Dimension value matching the search query.
2 properties
telemetry.DruidTimeBoundaryResult
object
The earliest and latest timestamps for a dataset
2 properties
telemetry.DruidSegmentMetadataResult
object
Metadata about a Druid segment
7 properties
telemetry.DruidDataSourceMetadataResult
object
Metadata about a Druid datasource
2 properties
telemetry.DruidBaseGranularity
object
The base structure for a Druid granularity.
1 property
1 required
telemetry.DruidGranularity
The granularity field determines how data gets bucketed across the time dimension, or how it gets aggregated by hour, day, minute, etc. It can be specified eit…
telemetry.DruidDurationGranularity
Duration granularities are specified as an exact duration in milliseconds and timestamps are returned as UTC. Duration granularity values are in milliseconds.…
telemetry.DruidPeriodGranularity
Period granularities are specified as arbitrary period combinations of years, months, weeks, hours, minutes and seconds (e.g., P2W, P3M, PT1H30M, PT0.750S) in…
telemetry.DruidBaseDataSource
object
A data source is the Apache Druid equivalent of a database table. However, a query can also masquerade as a data source, providing subquery-like functionality.…
1 property
1 required
telemetry.DruidDataSource
A data source is the Apache Druid equivalent of a database table. However, a query can also masquerade as a data source, providing subquery-like functionality.…
telemetry.DruidTableDataSource
The table data source is the most common datasource type. They are split up into segments, distributed around the cluster, and queried in parallel.
telemetry.DruidUnionDataSource
This data source unions two or more table data sources. Note that the data sources being unioned should have the same schema.
telemetry.DruidQueryDataSource
This is used for nested groupBys and is only currently supported for groupBys.
telemetry.DruidLookupDataSource
Lookup datasources correspond to Druid's key-value lookup objects. In Druid SQL, they reside in the the lookup schema. They are preloaded in memory on all serv…
telemetry.DruidInlineDataSource
Inline datasources allow you to query a small amount of data that is embedded in the query itself. They are useful when you want to write a query on a small am…
telemetry.DruidJoinDataSource
Join datasources allow you to do a SQL-style join of two datasources. Stacking joins on top of each other allows you to join arbitrarily many datasources. Join…
telemetry.DruidBaseTopNMetricSpec
object
A Druid TopN metric spec.
1 property
1 required
telemetry.DruidTopNMetricSpec
A Druid TopN metric spec.
telemetry.DruidNumericTopNMetricSpec
The simplest metric specification is a String value indicating the metric to sort topN results by.
telemetry.DruidDimensionTopNMetricSpec
This metric specification sorts TopN results by dimension value, using one of the sorting orders.
telemetry.DruidInvertedTopNMetricSpec
Sort dimension values in inverted order, i.e inverts the order of the delegate metric spec. It can be used to sort the values in ascending order.
telemetry.DruidBaseDimensionSpec
object
A dimension spec is used in a query to operate on dimension values.
1 property
1 required
telemetry.DruidDimensionSpec
telemetry.DruidDefaultDimensionSpec
Returns dimension values as is and optionally renames the dimension.
telemetry.DruidExtractionDimensionSpec
Returns dimension values transformed using the given extraction function.
telemetry.DruidExtractionFunction
The extraction function is used to transform input values before the filter is applied. Transformations can be applied to both regular (string) dimensions, as…
telemetry.DruidBaseExtractionFunction
object
Extraction functions define the transformation applied to each dimension value. Transformations can be applied to both regular (string) dimensions, as well as…
1 property
1 required
telemetry.DruidExtractionFunctionRegex
Returns the first matching group for the given regular expression. If there is no match, it returns the dimension value as is.
telemetry.DruidExtractionFunctionPartial
Returns the dimension value unchanged if the regular expression matches, otherwise returns null.
telemetry.DruidExtractionFunctionSearchQuery
Returns the dimension value unchanged if the given SearchQuerySpec matches, otherwise returns null.
telemetry.DruidExtractionFunctionSubstring
Returns a substring of the dimension value starting from the supplied index and of the desired length. Both index and length are measured in the number of Unic…
telemetry.DruidExtractionFunctionStrlen
Returns the length of dimension values, as measured in the number of Unicode code units present in the string as if it were encoded in UTF-16. Note that some U…
telemetry.DruidExtractionFunctionTimeFormat
Returns the dimension value formatted according to the given format string, time zone, and locale. For time dimension values, this formats the time value bucke…
telemetry.DruidExtractionFunctionTimeParsing
Parses dimension values as timestamps using the given input format, and returns them formatted using the given output format. Note, if you are working with the…
telemetry.DruidExtractionFunctionInlineLookup
Lookups are a concept in Druid where dimension values are (optionally) replaced with new values. The "lookup" extraction function lets you specify an inline lo…
telemetry.DruidExtractionFunctionCascade
Provides chained execution of extraction functions. A property of extractionFns contains an array of any extraction functions, which is executed in the array i…
telemetry.DruidExtractionFunctionStringFormat
Returns the dimension value formatted according to the given format string.
telemetry.DruidExtractionFunctionUpperCase
Returns the dimension values as all upper case. Optionally user can specify the language to use in order to perform upper transformation.
telemetry.DruidExtractionFunctionLowerCase
Returns the dimension values as all lower case. Optionally user can specify the language to use in order to perform lower transformation.
telemetry.DruidExtractionFunctionBucket
Bucket extraction function is used to bucket numerical values in each range of the given size by converting them to the same base value. Non numeric values are…
telemetry.DruidBaseHavingFilter
object
A having clause is a JSON object identifying which rows from a groupBy query should be returned, by specifying conditions on aggregated values. It is essential…
1 property
1 required
telemetry.DruidHavingFilter
telemetry.DruidHavingQueryFilter
Query filter HavingSpecs allow all Druid query filters to be used in the Having part of the query.
telemetry.DruidHavingNumericFilter
The simplest having clause is a numeric filter. Numeric filters can be used as the base filters for more complex boolean expressions of filters.
telemetry.DruidHavingDimensionSelectorFilter
The dimSelector filter will match rows with dimension values equal to the specified value.
telemetry.DruidBaseFilter
object
A filter is a JSON object indicating which rows of data should be included in the computation for a query. It's essentially the equivalent of the WHERE clause…
1 property
1 required
telemetry.DruidSelectorFilter
The selector filter matches a specific dimension with a specific value. Selector filters can be used as the base filters for more complex Boolean expressions o…
telemetry.DruidEqualityFilter
The equality filter is a replacement for the selector filter with the ability to match against any type of column. The equality filter is designed to have more…
telemetry.DruidNullFilter
The null filter is a partial replacement for the selector filter. It is dedicated to matching NULL values.
telemetry.DruidInFilter
The in filter can match input rows against a set of values, where a match occurs if the value is contained in the set. If an empty values array is passed to th…
telemetry.DruidBoundFilter
Bound filters can be used to filter on ranges of dimension values. It can be used for comparison filtering like greater than, less than, greater than or equal…
telemetry.DruidRangeFilter
The range filter is a replacement for the bound filter. It compares against any type of column and is designed to have has more SQL compliant behavior than the…
telemetry.DruidLikeFilter
Like filters can be used for basic wildcard searches. They are equivalent to the SQL LIKE operator. Special characters supported are "%" (matches any number of…
telemetry.DruidColumnComparisonFilter
The column comparison filter compares dimensions to each other.
telemetry.DruidRegexFilter
The regular expression filter is similar to the selector filter, but using regular expressions. It matches the specified dimension with the given pattern. Note…
telemetry.DruidIntervalFilter
The Interval filter enables range filtering on columns that contain long millisecond values, with the boundaries specified as ISO 8601 time intervals. It is su…
telemetry.DruidTrueFilter
A filter which matches all values. You can use it to temporarily disable other filters without removing them.
telemetry.DruidFalseFilter
A filter matches no values. You can use it to force a query to match no values.
telemetry.DruidSearchFilter
You can use search filters to filter on partial string matches.
telemetry.DruidBaseQuerySpec
object
A Druid query spec.
1 property
1 required
telemetry.DruidQuerySpecContains
A 'contains' query spec.
telemetry.DruidQuerySpecInsensitiveContains
A 'insensitivecontains' query spec. Note that an "insensitivecontains" search is equivalent to a "contains" search with "caseSensitive" false (or not provided).
telemetry.DruidQuerySpecFragment
A 'fragment' query spec.
telemetry.DruidExpressionFilter
The expression filter allows for the implementation of arbitrary conditions, leveraging the Druid expression system. This filter allows for complete flexibilit…
telemetry.DruidAndFilter
A logical AND expression filter.
telemetry.DruidOrFilter
A logical OR expression filter.
telemetry.DruidNotFilter
A logical NOT expression filter.
telemetry.DruidBaseAggregator
object
A Druid aggregator.
1 property
1 required
telemetry.DruidAggregator
telemetry.DruidCountAggregator
Computes the count of Druid rows that match the filters. The count aggregator counts the number of Druid rows, which does not always reflect the number of raw…
telemetry.DruidSumAggregator
Computes the sum of values.
telemetry.DruidMinMaxAggregator
Computes the min or max of values.
telemetry.DruidFirstLastAggregator
(Double/Float/Long) First and Last aggregator cannot be used in ingestion spec, and should only be specified as part of queries. Note that queries with first/l…
telemetry.DruidStringFirstLastAggregator
Computes the metric value with the minimum/maximum timestamp or null if no row exist.
telemetry.DruidAnyAggregator
Returns any value including null. This aggregator can simplify and optimize the performance by returning the first encountered value (including null).
telemetry.DruidStringAnyAggregator
Returns any value including null. This aggregator can simplify and optimize the performance by returning the first encountered value (including null).
telemetry.DruidFilteredAggregator
A filtered aggregator wraps any given aggregator, but only aggregates the values for which the given dimension filter matches. This makes it possible to comput…
telemetry.DruidThetaSketchAggregator
Theta sketch aggregation provides a class of specialized algorithms, called streaming algorithms, or sketches that can produce results orders-of magnitude fast…
telemetry.DruidBaseLimitSpec
object
The limitSpec field provides the functionality to sort and limit the set of results from a groupBy query. If you group by a single dimension and are ordering b…
1 property
1 required
telemetry.DruidDefaultLimitSpec
The default limit spec takes a limit and the list of columns to do an orderBy operation over.
telemetry.DruidOrderByColumnSpec
object
OrderByColumnSpecs indicate how to do order by operations. Each order-by condition can be a jsonString or a map.
3 properties
telemetry.DruidBaseVirtualColumn
object
Virtual columns are columns that are computed on the fly during query execution. If you include a virtual column as part of a query, make sure to include all a…
1 property
1 required
telemetry.DruidVirtualColumn
telemetry.DruidExpressionVirtualColumn
A virtual column defined as a Druid expression. Supported Druid expressions are documented at https://druid.apache.org/docs/latest/misc/math-expr.html.
telemetry.NestedFieldVirtualColumn
A virtual column defined as a nested field. The nested field virtual column is an optimized virtual column that can provide direct access into various paths of…
telemetry.DruidListFilteredVirtualColumn
This virtual column provides an alternative way to use 'list filtered' dimension spec as a virtual column. It has optimized access to the underlying column val…
telemetry.DruidBasePostAggregator
object
Post-aggregations are specifications of processing that should happen on aggregated values as they come out of Apache Druid. If you include a post aggregation…
2 properties
1 required
telemetry.DruidPostAggregator
telemetry.DruidArithmeticPostAggregator
The arithmetic post-aggregator applies the provided function to the given fields from left to right. The fields can be aggregators or other post aggregators. S…
telemetry.DruidExpressionPostAggregator
A post-aggregator defined as a Druid expression. Supported Druid expressions are documented at https://druid.apache.org/docs/latest/misc/math-expr.html.
telemetry.DruidFieldAccessorPostAggregator
These post-aggregators return the value produced by the specified aggregator. 'fieldName' refers to the output name of the aggregator given in the aggregations…
telemetry.DruidConstantPostAggregator
The constant post-aggregator always returns the specified value.
telemetry.DruidGreatestLeastPostAggregator
doubleGreatest and longGreatest computes the maximum of all fields and Double.NEGATIVEINFINITY. doubleLeast and longLeast computes the minimum of all fields an…
telemetry.DruidHyperUniquePostAggregator
The hyperUniqueCardinality post aggregator is used to wrap a hyperUnique object such that it can be used in post aggregations. This post-aggregator will inheri…
telemetry.DruidThetaSketchEstimatePostAggregator
Post aggregator of type fieldAccess that refers to a thetaSketch aggregator or that of type thetaSketchSetOp.
telemetry.DruidThetaSketchOperationsPostAggregator
telemetry.DruidQueryContext
object
The query context is used for various query configuration parameters. Can be used to modify query behavior, including grand totals and zero-filling.
20 properties
telemetry.DruidTimeSeriesRequest
These types of queries take a timeseries query object and return an array of JSON objects where each object represents a value asked for by the timeseries quer…
telemetry.DruidTopNRequest
TopN queries return a sorted set of results for the values in a given dimension according to some criteria. Conceptually, they can be thought of as an approxim…
telemetry.DruidGroupByRequest
These types of Apache Druid queries take a groupBy query object and return an array of JSON objects where each object represents a grouping asked for by the qu…
telemetry.DruidScanRequest
The Scan query returns raw Apache Druid rows in streaming mode. In addition to straightforward usage where a Scan query is issued to the Broker, the Scan query…
telemetry.DruidSearchRequest
These types of queries returns dimension values that match the search specification
telemetry.DruidBaseSearchSpec
object
The base structure for all Druid search specifications.
1 property
1 required
telemetry.DruidAggregateSearchSpec
Generic search specification descriptor
telemetry.DruidInsensitiveContainsSearchSpec
The specification for a Druid 'insensitivecontains' search
telemetry.DruidFragmentSearchSpec
The specification for a Druid 'insensitivecontains' search
telemetry.DruidContainsSearchSpec
The specification for a Druid 'insensitivecontains' search
telemetry.DruidRegexSearchSpec
The specification for a Druid 'insensitivecontains' search
telemetry.DruidTimeBoundaryRequest
Time boundary queries return the earliest and latest data points of a data set.
telemetry.DruidSegmentMetadataRequest
Time boundary queries return the earliest and latest data points of a data set.
telemetry.DruidDataSourceMetadataRequest
Data Source Metadata queries return metadata information for a dataSource. These queries return information about the timestamp of latest ingested event for th…
search.SuggestItem.Response
The response body of a HTTP GET request for the 'search.SuggesthItem' resource.
search.SuggestItem
This resource is used to search for objects matching a criteria in the endpoint.
search.SuggestItem.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
apiproxy.AllowList.Response
The response body of a HTTP GET request for the 'apiproxy.AllowList' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
apiproxy.AllowList
Object representing the platform's API Allow-List used by the casanova proxy server.
apiproxy.AllowList.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ApiStatus
Status of an API. APIs are all get type and from ApiDocs.
appliance.AppOpStatus.Response
The response body of a HTTP GET request for the 'appliance.AppOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.AppOpStatus.Relationship
A relationship to the 'appliance.AppOpStatus' resource, or the expanded 'appliance.AppOpStatus' resource, or the 'null' value.
appliance.AppOpStatus
The AppOpStatus object articulates the operational status of applications running on the Intersight Appliance. It tracks the application's readiness and perfor…
appliance.AppOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.AppStatus.Response
The response body of a HTTP GET request for the 'appliance.AppStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.AppStatus.Relationship
A relationship to the 'appliance.AppStatus' resource, or the expanded 'appliance.AppStatus' resource, or the 'null' value.
appliance.AppStatus
Status of an application.
appliance.AppStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.AutoRmaPolicy.Response
The response body of a HTTP GET request for the 'appliance.AutoRmaPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.AutoRmaPolicy
Auto rma policy to decide whether rma data should be collected.
appliance.AutoRmaPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.Backup.Response
The response body of a HTTP GET request for the 'appliance.Backup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
appliance.Backup.Relationship
A relationship to the 'appliance.Backup' resource, or the expanded 'appliance.Backup' resource, or the 'null' value.
appliance.Backup
The Backup object is essential for managing system backups, ensuring data integrity and continuity through structured backup requests and processes. Purpose Th…
appliance.Backup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.BackupBase
BackupBase is the parent type of Backup, Restore, and BackupPolicy managed objects. BackupBase holds the common information required for copying the file from…
appliance.BackupDownload.Response
The response body of a HTTP GET request for the 'appliance.BackupDownload' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.BackupDownload
The BackupDownload object represents the download of a backup file, providing a secure and efficient mechanism for retrieving backup artifacts. Purpose The Bac…
appliance.BackupDownload.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.BackupMonitor.Response
The response body of a HTTP GET request for the 'appliance.BackupMonitor' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.BackupMonitor
The BackupMonitor object plays a pivotal role in overseeing the history and status of backup operations, ensuring ongoing data protection and system reliabilit…
appliance.BackupMonitor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.BackupPolicy.Response
The response body of a HTTP GET request for the 'appliance.BackupPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
appliance.BackupPolicy
The BackupPolicy object defines the strategic approach to system backups, setting guidelines and parameters for regular data protection operations. Purpose Bac…
appliance.BackupPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.BackupRotateData.Response
The response body of a HTTP GET request for the 'appliance.BackupRotateData' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.BackupRotateData
BackupRotateData tracks the set of current backups being managed under a backup rotation policy. It serves as the system’s record for actively managing backups…
appliance.BackupRotateData.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.CertRenewalPhase
CertRenewalPhase represents a phase of the Intersight Appliance certificate renewal process.
appliance.CertificateSetting.Response
The response body of a HTTP GET request for the 'appliance.CertificateSetting' resource. The value may be one of the following types. 1. When 'tag' is specifie…
appliance.CertificateSetting
The CertificateSetting object manages the certificate used by the Intersight Appliance for browser traffic. It ensures secure communication between the applian…
appliance.CertificateSetting.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterInfo.Response
The response body of a HTTP GET request for the 'appliance.ClusterInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.ClusterInfo
ClusterInfo model is used for a peer appliance to create a cluster with an existing, fully configured appliance.
appliance.ClusterInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterInstall.Response
The response body of a HTTP GET request for the 'appliance.ClusterInstall' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.ClusterInstall
ClusterInstall is a singleton that tracks the Intersight Appliance's install of two additional nodes.
appliance.ClusterInstall.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterInstallBase
MultinodeInstall is a singleton that tracks the Intersight Appliance's install of two additional nodes.
appliance.ClusterInstallPhase
A phase in the Intersight Appliance cluster installation life cycle.
appliance.ClusterReplaceNode.Response
The response body of a HTTP GET request for the 'appliance.ClusterReplaceNode' resource. The value may be one of the following types. 1. When 'tag' is specifie…
appliance.ClusterReplaceNode
ClusterReplaceNode is a singleton that tracks the Intersight Appliance's process for replacing a cluster node.
appliance.ClusterReplaceNode.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterWorkerNode.Response
The response body of a HTTP GET request for the 'appliance.ClusterWorkerNode' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.ClusterWorkerNode
ClusterWorkerNode is an object that tracks the Intersight Appliance's process for adding a worker node.
appliance.ClusterWorkerNode.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterWorkerNodeReplace
ClusterWorkerNodeReplace is an object that marks the worker node out of service for replacement.
appliance.ClusterWorkerNodeReuse
The ClusterWorkerNodeReuse object facilitates the reconnection process for worker nodes within the Intersight Appliance cluster. It triggers the appliance's pr…
appliance.CpuUtilization.Response
The response body of a HTTP GET request for the 'appliance.CpuUtilization' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.CpuUtilization
CPU utilization metrics for Intersight Appliance nodes. Tracks the percentage of CPU capacity being used, helping administrators monitor processor load and ide…
appliance.CpuUtilization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DataExportPolicy.Response
The response body of a HTTP GET request for the 'appliance.DataExportPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.DataExportPolicy.Relationship
A relationship to the 'appliance.DataExportPolicy' resource, or the expanded 'appliance.DataExportPolicy' resource, or the 'null' value.
appliance.DataExportPolicy
DataExportPolicies define category-based data collection controls for exporting data from an Intersight Appliance to Intersight. The policy is organized as a h…
appliance.DataExportPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceCertificate.Response
The response body of a HTTP GET request for the 'appliance.DeviceCertificate' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.DeviceCertificate
The DeviceCertificate object stores the CA Certificate used by the Intersight Appliance's device connector. It tracks the renewal process and ensures the certi…
appliance.DeviceCertificate.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceClaim.Response
The response body of a HTTP GET request for the 'appliance.DeviceClaim' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.DeviceClaim
The DeviceClaim object represents a user-initiated claim request for endpoint devices within the Intersight Appliance. It facilitates the multi-step operation…
appliance.DeviceClaim.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceClusterInstall.Response
The response body of a HTTP GET request for the 'appliance.DeviceClusterInstall' resource. The value may be one of the following types. 1. When 'tag' is specif…
appliance.DeviceClusterInstall
The DeviceClusterInstall object tracks the installation process of Intersight Cluster Appliances, providing insights into system setup and configuration. Purpo…
appliance.DeviceClusterInstall.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceState.Response
The response body of a HTTP GET request for the 'appliance.DeviceState' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.DeviceState
The DeviceState object captures the current operational state of Intersight Appliances, providing critical data for system monitoring and management. Purpose D…
appliance.DeviceState.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceUpgradePolicy.Response
The response body of a HTTP GET request for the 'appliance.DeviceUpgradePolicy' resource. The value may be one of the following types. 1. When 'tag' is specifi…
appliance.DeviceUpgradePolicy.Relationship
A relationship to the 'appliance.DeviceUpgradePolicy' resource, or the expanded 'appliance.DeviceUpgradePolicy' resource, or the 'null' value.
appliance.DeviceUpgradePolicy
The DeviceUpgradePolicy object defines the upgrade policies of Intersight Appliances, guiding the automated and scheduled distribution of software updates. Pur…
appliance.DeviceUpgradePolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DiagSetting.Response
The response body of a HTTP GET request for the 'appliance.DiagSetting' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.DiagSetting
The DiagSetting object is used to manage the password of the Intersight Appliance's OS diagnostic user account. It is designed to ensure secure access to the a…
appliance.DiagSetting.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ExternalSyslogSetting.Response
The response body of a HTTP GET request for the 'appliance.ExternalSyslogSetting' resource. The value may be one of the following types. 1. When 'tag' is speci…
appliance.ExternalSyslogSetting
The ExternalSyslogSetting object configures the external Syslog server for the Intersight Appliance. It allows administrators to define how Syslog messages are…
appliance.ExternalSyslogSetting.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.FileGateway.Response
The response body of a HTTP GET request for the 'appliance.FileGateway' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.FileGateway
The FileGateway object provides non-persistent access to files from the Intersight, facilitating efficient file retrieval and storage. Purpose FileGateway acts…
appliance.FileGateway.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.FileSystemOpStatus.Response
The response body of a HTTP GET request for the 'appliance.FileSystemOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specifie…
appliance.FileSystemOpStatus.Relationship
A relationship to the 'appliance.FileSystemOpStatus' resource, or the expanded 'appliance.FileSystemOpStatus' resource, or the 'null' value.
appliance.FileSystemOpStatus
The FileSystemOpStatus object denotes the operational status of file systems within an Intersight Appliance node. It highlights the capacity and usage metrics…
appliance.FileSystemOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.FileSystemOpSummary.Response
The response body of a HTTP GET request for the 'appliance.FileSystemOpSummary' resource. The value may be one of the following types. 1. When 'tag' is specifi…
appliance.FileSystemOpSummary.Relationship
A relationship to the 'appliance.FileSystemOpSummary' resource, or the expanded 'appliance.FileSystemOpSummary' resource, or the 'null' value.
appliance.FileSystemOpSummary
The FileSystemOpSummary object aggregates alarm summaries for file systems on an Intersight Appliance node. It serves as an essential tool for maintaining syst…
appliance.FileSystemOpSummary.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.FileSystemStatus.Response
The response body of a HTTP GET request for the 'appliance.FileSystemStatus' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.FileSystemStatus.Relationship
A relationship to the 'appliance.FileSystemStatus' resource, or the expanded 'appliance.FileSystemStatus' resource, or the 'null' value.
appliance.FileSystemStatus
Status of a file system on an Intersight Appliance node.
appliance.FileSystemStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.FileSystemTelemetry.Response
The response body of a HTTP GET request for the 'appliance.FileSystemTelemetry' resource. The value may be one of the following types. 1. When 'tag' is specifi…
appliance.FileSystemTelemetry
Calculated operational status of a file system on a node.
appliance.FileSystemTelemetry.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.FqdnUpdate.Response
The response body of a HTTP GET request for the 'appliance.FqdnUpdate' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.FqdnUpdate
FqdnUpdate provides configuration parameters for updating Appliance FQDN (fully qualified domain name) on claimed Endpoints. Appliance with new FQDN should be…
appliance.FqdnUpdate.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.GroupOpStatus.Response
The response body of a HTTP GET request for the 'appliance.GroupOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.GroupOpStatus.Relationship
A relationship to the 'appliance.GroupOpStatus' resource, or the expanded 'appliance.GroupOpStatus' resource, or the 'null' value.
appliance.GroupOpStatus
The GroupOpStatus object describes the status of a group of applications within the Intersight Appliance system. It consolidates application-specific status to…
appliance.GroupOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.GroupStatus.Response
The response body of a HTTP GET request for the 'appliance.GroupStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.GroupStatus.Relationship
A relationship to the 'appliance.GroupStatus' resource, or the expanded 'appliance.GroupStatus' resource, or the 'null' value.
appliance.GroupStatus
Status of a group of applications.
appliance.GroupStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ImageBundle.Response
The response body of a HTTP GET request for the 'appliance.ImageBundle' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.ImageBundle.Relationship
A relationship to the 'appliance.ImageBundle' resource, or the expanded 'appliance.ImageBundle' resource, or the 'null' value.
appliance.ImageBundle
The ImageBundle object plays a pivotal role in managing software bundles within the Intersight Appliance. It keeps track of all installed software bundles, der…
appliance.ImageBundle.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.KeyValuePair
An arbitrary key and value pair that can be used to for having pair of key and values in application such as Appliance Capabilities.
appliance.MemoryUtilization.Response
The response body of a HTTP GET request for the 'appliance.MemoryUtilization' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.MemoryUtilization
Memory utilization metrics for Intersight Appliance nodes. Measures the percentage of physical RAM being consumed, enabling monitoring of memory pressure and c…
appliance.MemoryUtilization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.MetaManifest.Response
The response body of a HTTP GET request for the 'appliance.MetaManifest' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
appliance.MetaManifest
MetaManifest managed object describes the files by downloading from the S3 and without having required user to run the upgrade for the appliance. This MO will…
appliance.MetaManifest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.MetadataManifestVersion
BucketVersion is a 3 tuple (bucketName, timestamp of when the metamanifest was touched, checksum). Uniquely identifies a single metadata update to a bucket.
appliance.MetricBase
A metric that reports a value or set of values over a measurement period.
appliance.MetricsConfig.Response
The response body of a HTTP GET request for the 'appliance.MetricsConfig' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.MetricsConfig
The MetricsConfig object provides configuration parameters for managing metrics collection on the Intersight Appliance. It supports system and user-defined met…
appliance.MetricsConfig.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.MetricsIngestionUtilization.Response
The response body of a HTTP GET request for the 'appliance.MetricsIngestionUtilization' resource. The value may be one of the following types. 1. When 'tag' is…
appliance.MetricsIngestionUtilization
Measures the utilization of the metrics feature in relation to the available capacity of the system.
appliance.MetricsIngestionUtilization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NetworkLinkStatus.Response
The response body of a HTTP GET request for the 'appliance.NetworkLinkStatus' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.NetworkLinkStatus.Relationship
A relationship to the 'appliance.NetworkLinkStatus' resource, or the expanded 'appliance.NetworkLinkStatus' resource, or the 'null' value.
appliance.NetworkLinkStatus
The NetworkLinkStatus object examines the network connection between nodes in an Intersight Appliance cluster. It is vital for ensuring seamless communication…
appliance.NetworkLinkStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NetworkStatus
Time to ping a target endpoint.
appliance.NodeInfo.Response
The response body of a HTTP GET request for the 'appliance.NodeInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
appliance.NodeInfo.Relationship
A relationship to the 'appliance.NodeInfo' resource, or the expanded 'appliance.NodeInfo' resource, or the 'null' value.
appliance.NodeInfo
The NodeInfo object is designed to store the cluster node information of the Intersight Appliance. Created during the appliance's setup, NodeInfo objects are u…
appliance.NodeInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NodeIopsMetric.Response
The response body of a HTTP GET request for the 'appliance.NodeIopsMetric' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NodeIopsMetric
Input/Output operations per second (IOPS) metrics for Intersight Appliance nodes. Measures the aggregate rate of disk read and write operations, providing insi…
appliance.NodeIopsMetric.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NodeIpInfo
NodeInfo contains the hostname, ip address, and node number for a node.
appliance.NodeMetricBase
Base class for all metrics collected from Intersight Appliance nodes.
appliance.NodeOpStatus.Response
The response body of a HTTP GET request for the 'appliance.NodeOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
appliance.NodeOpStatus.Relationship
A relationship to the 'appliance.NodeOpStatus' resource, or the expanded 'appliance.NodeOpStatus' resource, or the 'null' value.
appliance.NodeOpStatus
The NodeOpStatus object captures the status of individual nodes within the Intersight Appliance. It is essential for understanding node-specific operational me…
appliance.NodeOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NodeStatus.Response
The response body of a HTTP GET request for the 'appliance.NodeStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.NodeStatus.Relationship
A relationship to the 'appliance.NodeStatus' resource, or the expanded 'appliance.NodeStatus' resource, or the 'null' value.
appliance.NodeStatus
Status of an Intersight Appliance node.
appliance.NodeStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NodeTelemetry.Response
The response body of a HTTP GET request for the 'appliance.NodeTelemetry' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NodeTelemetry
NodeTelemetry represents the operational status of an Assist node, including CPU, memory, and disk usage metrics collected from Prometheus.
appliance.NodeTelemetry.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NodeUtilizationMetric
Base class for percentage-based utilization metrics collected from Intersight Appliance nodes.
appliance.ReleaseNote.Response
The response body of a HTTP GET request for the 'appliance.ReleaseNote' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.ReleaseNote
ReleaseUpdate managed the object provides the information preview (new features and bug fixes) for one pending upgrade.
appliance.ReleaseNote.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.RemoteFileImport.Response
The response body of a HTTP GET request for the 'appliance.RemoteFileImport' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.RemoteFileImport
The RemoteFileImport object supports the import of firmware images to the Intersight Appliance. It facilitates remote requests via SCP or SFTP to download file…
appliance.RemoteFileImport.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.Restore.Response
The response body of a HTTP GET request for the 'appliance.Restore' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
appliance.Restore
The Restore object is crucial for handling system restoration requests, enabling recovery operations to maintain system stability and data accuracy. Purpose Th…
appliance.Restore.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.SetupInfo.Response
The response body of a HTTP GET request for the 'appliance.SetupInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.SetupInfo
SetupInfo will have only one managed object. SetupInfo managed object is to keep track of the Intersight Appliance's setup information and guide the UI through…
appliance.SetupInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.StatusCheck
Status check on an Intersight Appliance entity.
appliance.SystemInfo.Response
The response body of a HTTP GET request for the 'appliance.SystemInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.SystemInfo.Relationship
A relationship to the 'appliance.SystemInfo' resource, or the expanded 'appliance.SystemInfo' resource, or the 'null' value.
appliance.SystemInfo
The SystemInfo object represents the Intersight Appliance's system information. It is a singleton managed object that is created during the setup of the Inters…
appliance.SystemInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.SystemOpStatus.Response
The response body of a HTTP GET request for the 'appliance.SystemOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.SystemOpStatus.Relationship
A relationship to the 'appliance.SystemOpStatus' resource, or the expanded 'appliance.SystemOpStatus' resource, or the 'null' value.
appliance.SystemOpStatus
The SystemOpStatus object represents the status of the Intersight Appliance within a system. This provides a comprehensive view of the appliance's operational…
appliance.SystemOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.SystemStatus.Response
The response body of a HTTP GET request for the 'appliance.SystemStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
appliance.SystemStatus.Relationship
A relationship to the 'appliance.SystemStatus' resource, or the expanded 'appliance.SystemStatus' resource, or the 'null' value.
appliance.SystemStatus
Status of the Intersight Appliance.
appliance.SystemStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.Upgrade.Response
The response body of a HTTP GET request for the 'appliance.Upgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
appliance.Upgrade.Relationship
A relationship to the 'appliance.Upgrade' resource, or the expanded 'appliance.Upgrade' resource, or the 'null' value.
appliance.Upgrade
The Upgrade object is a crucial component within the Intersight Appliance's software management system, responsible for tracking and managing software upgrades…
appliance.Upgrade.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.UpgradePolicy.Response
The response body of a HTTP GET request for the 'appliance.UpgradePolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.UpgradePolicy
UpgradePolicy stores the Intersight Appliance's software upgrade policy. UpgradePolicy is a sinlgeton managed object. A default upgrade policy is created durin…
appliance.UpgradePolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.UpgradeTracker.Response
The response body of a HTTP GET request for the 'appliance.UpgradeTracker' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.UpgradeTracker
The UpgradeTracker object is designed to monitor the history of software upgrades within the Intersight Appliance. It acts as a singleton object to facilitate…
appliance.UpgradeTracker.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.UtilizationMetric
A utilization metric represents the percentage utilization of a resource.
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.
auditd.LogMonitorType
The log monitor is used to configure monitoring of specific log events in the AuditD feature.
auditd.Policy.Response
The response body of a HTTP GET request for the 'auditd.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
auditd.Policy
A policy to configure the kernel level AuditD settings in the Fabric Interconnect/Servers.
auditd.Policy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
blueprint.BaseGeneratedObjectSourceFromSelector
Base type to capture common details of how the source object is provided from an existing object using a selector. The selector consists of a URL that is the R…
blueprint.BaseGeneratedObjectSourceMetadata
Base type to capture common details of how the source object is provided.
blueprint.BlueprintDefinitionDependency
Definition to capture a dependency on another blueprint that is referred in this blueprint.
blueprint.GeneratedObjectMetadata
Type to capture the details of the generated objects.
blueprint.GeneratedObjectNew
Type to capture complete details of how the new object is generated.
blueprint.GeneratedObjectOperationTarget
The target of a pre-generation operation performed before an object is generated.
blueprint.GeneratedObjectSourceClone
Type to capture complete details of how the source object is provided.
blueprint.GeneratedObjectSourceLookup
Type to capture complete details of how the source object is provided.
blueprint.GeneratedObjectSourceMerge
The metadata for performing a merge operation between a source object and one or more targets. The merge operation can be a strict merge, in which empty proper…
blueprint.GeneratedObjectSourceReference
Type to capture complete details of how the source object is provided.
blueprint.GeneratedObjectSourceSelector
Type to capture the source object selector details.
blueprint.InputOperationType
Type to capture the operation details for the input.
blueprint.PreGenerateOperation
A set of MO operations to be executed before generating the object. The operations are run prior to object generation and can be used to perform additional cle…
blueprint.PropertyIteration
The input to control loop iterations when deriving array properties in a generated object.
blueprint.ResourceConstraints
Type to capture the resource constraints for the blueprints.
blueprint.ServiceItemDefinition
Definition to capture the service item that is being referred in this blueprint.
bulk.ApiResult
The result of an individual REST API action.
bulk.BaseExport.Relationship
A relationship to the 'bulk.BaseExport' resource, or the expanded 'bulk.BaseExport' resource, or the 'null' value.
bulk.BaseExport
The Export MO is the top level MO that is created by the user to represent an export operation and this abstract MO is used to hold references of concrete ging…
bulk.Export.Response
The response body of a HTTP GET request for the 'bulk.Export' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
bulk.Export.Relationship
A relationship to the 'bulk.Export' resource, or the expanded 'bulk.Export' resource, or the 'null' value.
bulk.Export
The Export object is integral to managing export operations within the system, providing a structured approach to monitor and control various aspects of data e…
bulk.Export.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.ExportedItem.Response
The response body of a HTTP GET request for the 'bulk.ExportedItem' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
bulk.ExportedItem.Relationship
A relationship to the 'bulk.ExportedItem' resource, or the expanded 'bulk.ExportedItem' resource, or the 'null' value.
bulk.ExportedItem
A single managed object that is being exported.
bulk.ExportedItem.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.HttpHeader
The HttpHeader object represents an HTTP header within the context of API operations. It is used to specify metadata in the form of key-value pairs accompanyin…
bulk.MoCloner.Response
The response body of a HTTP GET request for the 'bulk.MoCloner' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
bulk.MoCloner.Relationship
A relationship to the 'bulk.MoCloner' resource, or the expanded 'bulk.MoCloner' resource, or the 'null' value.
bulk.MoCloner
The MoCloner object is an interface designed to facilitate the cloning of managed objects (MOs) in bulk operations. It enables the creation of multiple copies…
bulk.MoCloner.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.MoDeepCloner.Response
The response body of a HTTP GET request for the 'bulk.MoDeepCloner' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
bulk.MoDeepCloner.Relationship
A relationship to the 'bulk.MoDeepCloner' resource, or the expanded 'bulk.MoDeepCloner' resource, or the 'null' value.
bulk.MoDeepCloner
The MoDeepCloner object is an advanced cloning interface that enables deep copies of managed objects (MOs). It supports the replication of complex structures w…
bulk.MoDeepCloner.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.MoMerger.Response
The response body of a HTTP GET request for the 'bulk.MoMerger' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
bulk.MoMerger.Relationship
A relationship to the 'bulk.MoMerger' resource, or the expanded 'bulk.MoMerger' resource, or the 'null' value.
bulk.MoMerger
The MoMerger object is an interface designed to merge properties of managed object (MO) instances. It allows for the synchronization and updating of multiple t…
bulk.MoMerger.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.MultiRelationEntryPatch
Internal type to enable patching of a multi relationship entry during MO clone.
bulk.PatchContent
Object that is used for patching a document.
bulk.RelatedTypeExportOption
Options to be used when instances of a related type are exported during an export operation.
bulk.Request.Response
The response body of a HTTP GET request for the 'bulk.Request' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
bulk.Request.Relationship
A relationship to the 'bulk.Request' resource, or the expanded 'bulk.Request' resource, or the 'null' value.
bulk.Request
Requests (bulk.Request) represent a bulk-operation submission that allows clients to execute multiple API actions—such as Create, Update, or Delete—against a g…
bulk.Request.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.RestResult
The result of an individual REST API action.
bulk.RestSubRequest
An individual REST API request to be executed as part of a bulk request.
bulk.Result.Response
The response body of a HTTP GET request for the 'bulk.Result' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
bulk.Result.Relationship
A relationship to the 'bulk.Result' resource, or the expanded 'bulk.Result' resource, or the 'null' value.
bulk.Result
The Result object serves as a status-monitoring resource within asynchronous bulk operations. This provides detailed insights into the processing status of bul…
bulk.Result.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.SecResourceRoles
Used to store the orgs and their associated roles for a given user permission in the security context.
bulk.SubRequest
An individual API request that is contained within a bulk request.
bulk.SubRequestObj.Response
The response body of a HTTP GET request for the 'bulk.SubRequestObj' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
bulk.SubRequestObj.Relationship
A relationship to the 'bulk.SubRequestObj' resource, or the expanded 'bulk.SubRequestObj' resource, or the 'null' value.
bulk.SubRequestObj
The SubRequestObj object represents an individual API request processed as part of a larger bulk operation. It serves as an internal record for every sub-reque…
bulk.SubRequestObj.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
bulk.SubRequestsGroup
A group of bulk sub requests that can be sent in a single bulk API request. In case of an export operation with many MOs, the exported MOs are grouped as many…
cli.CliPolicy.Response
The response body of a HTTP GET request for the 'cli.CliPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
cli.CliPolicy
The CliPolicy object manages policies controlling FI and Unified Edge eCMC CLI launches within the account. This provides configuration options for enabling or…
cli.CliPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cloud.CollectInventory
The CollectInventory object plays a crucial role in managing and collecting inventory data asynchronously after the creation of new Terraform Cloud targets. It…
cloud.TfcAgentpool.Response
The response body of a HTTP GET request for the 'cloud.TfcAgentpool' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
cloud.TfcAgentpool
The TfcAgentpool object is integral to managing groups of agents within Terraform Cloud, enabling communication with isolated, private, or on-premises infrastr…
cloud.TfcAgentpool.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cloud.TfcOrganization.Response
The response body of a HTTP GET request for the 'cloud.TfcOrganization' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
cloud.TfcOrganization.Relationship
A relationship to the 'cloud.TfcOrganization' resource, or the expanded 'cloud.TfcOrganization' resource, or the 'null' value.
cloud.TfcOrganization
The TfcOrganization object represents a collaborative space within Terraform Cloud, enabling teams to work together on shared workspaces. Intersight discovers…
cloud.TfcOrganization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cloud.TfcWorkspace.Response
The response body of a HTTP GET request for the 'cloud.TfcWorkspace' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
cloud.TfcWorkspace
The TfcWorkspace object serves as a representation of running infrastructure managed by Terraform. Purpose Intersight discovers the Workspaces in the Terraform…
cloud.TfcWorkspace.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cloud.TfcWorkspaceVariables
The variables associated with a workspace.
cmrf.CmRf
A reference to a REST resource from a complex type, uniquely identified by object type and Moid. CMRF is a short term workaround until MoRef properties of comp…
cond.AdapterBaselineStatus
Adapter baseline status specifies the adapter status and reason of being non-compliant when status is non-compliant.
cond.AdapterDetail
Adapter details for custom Hcl baseline.
cond.AdapterInfo
Adapter information like model, vendor, type, firmware and driver details.
cond.AdapterInstance
Adapter details retrieved from server.
cond.Alarm.Response
The response body of a HTTP GET request for the 'cond.Alarm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
cond.Alarm
The Alarm object represents the alarms generated by either the managed system itself or by Intersight. It is used for identifying and responding to issues dete…
cond.Alarm.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.AlarmAction
AlarmAction is used to define actions that are triggered in response to alarms. Purpose AlarmAction defines the specific rules and specifications used to const…
cond.AlarmAggregation.Response
The response body of a HTTP GET request for the 'cond.AlarmAggregation' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
cond.AlarmAggregation
The AlarmAggregation object is designed to represent aggregated alarm data for a managed endpoint within Intersight. It offers a consolidated view of alarm cou…
cond.AlarmAggregation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.AlarmClassification.Response
The response body of a HTTP GET request for the 'cond.AlarmClassification' resource. The value may be one of the following types. 1. When 'tag' is specified in…
cond.AlarmClassification.Relationship
A relationship to the 'cond.AlarmClassification' resource, or the expanded 'cond.AlarmClassification' resource, or the 'null' value.
cond.AlarmClassification
A group of related alarms that can be used in suppressions.
cond.AlarmClassification.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.AlarmClassificationEligibility
Same alarm classifications can be suppressed at many Intersight entity MO types. The entity MO types on which an alarm classification can be suppressed is dete…
cond.AlarmDefinition.Response
The response body of a HTTP GET request for the 'cond.AlarmDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
cond.AlarmDefinition.Relationship
A relationship to the 'cond.AlarmDefinition' resource, or the expanded 'cond.AlarmDefinition' resource, or the 'null' value.
cond.AlarmDefinition
AlarmDefinition describes alarm messages, including their meaning and recommended recovery actions. It helps identify alarms by providing details such as the a…
cond.AlarmDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.AlarmPreview
Contains a list of alarms with a fixed subset of fields needed to show a preview.
cond.AlarmRule.Response
The response body of a HTTP GET request for the 'cond.AlarmRule' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
cond.AlarmRule
A container object that aggregates a set of ThresholdDefinition objects. This can be assigned to one or more devices, triggering the creation of the AlarmDefin…
cond.AlarmRule.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.AlarmRuleExpression
A rule used to filter alarms. Alarms are specified using one or more groupings of property, operator and value.
cond.AlarmSpec
A specification of the details used to construct an alarm instance.
cond.AlarmSummary
The summary of alarm counts based on alarm serverity.
cond.AlarmSuppression.Response
The response body of a HTTP GET request for the 'cond.AlarmSuppression' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
cond.AlarmSuppression.Relationship
A relationship to the 'cond.AlarmSuppression' resource, or the expanded 'cond.AlarmSuppression' resource, or the 'null' value.
cond.AlarmSuppression
The AlarmSuppression is for selective suppression of alarms across various managed objects (MOs). It allows users to define which alarms should be hidden or su…
cond.AlarmSuppression.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.AlarmSuppressionDryRun
This API will return a list of alarms likely to be suppressed by a proposed rule.
cond.AlarmSuppressionDryRunSummary
Contains both the total count of alarms that would be impacted by an evaluated suppression rule, and a list of some of the alarms that might be suppressed. Thi…
cond.CustomHclBaseline.Response
The response body of a HTTP GET request for the 'cond.CustomHclBaseline' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
cond.CustomHclBaseline.Relationship
A relationship to the 'cond.CustomHclBaseline' resource, or the expanded 'cond.CustomHclBaseline' resource, or the 'null' value.
cond.CustomHclBaseline
The CustomHclBaseline object defines baseline configurations for Cisco servers within an organization. It allows administrators to specify hardware and softwar…
cond.CustomHclBaseline.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.CustomHclStatus.Response
The response body of a HTTP GET request for the 'cond.CustomHclStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
cond.CustomHclStatus
The CustomHclStatus object represents the compliance status of a Cisco server against defined Custom Hcl baseline within an organization. It contains detailed…
cond.CustomHclStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.FilterRule
Rule used to filter the alarms based on the severity type.
cond.HclStatus.Response
The response body of a HTTP GET request for the 'cond.HclStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
cond.HclStatus.Relationship
A relationship to the 'cond.HclStatus' resource, or the expanded 'cond.HclStatus' resource, or the 'null' value.
cond.HclStatus
The HCL Status stores the Hardware Compatibility List (HCL) validation status of servers. It evaluates the compatibility of Cisco Servers by checking if the ha…
cond.HclStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.HclStatusDetail.Response
The response body of a HTTP GET request for the 'cond.HclStatusDetail' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
cond.HclStatusDetail.Relationship
A relationship to the 'cond.HclStatusDetail' resource, or the expanded 'cond.HclStatusDetail' resource, or the 'null' value.
cond.HclStatusDetail
The HclStatusDetail object provides detailed validation information for each component's firmware and drivers against the Hardware Compatibility List (HCL). It…
cond.HclStatusDetail.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.HclStatusJob.Response
The response body of a HTTP GET request for the 'cond.HclStatusJob' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
cond.HclStatusJob
The HclStatusJob object is utilized to batch inventory notifications and process evaluations of HclStatus. It ensures timely and efficient handling of compatib…
cond.HclStatusJob.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.ServerBaselineStatus
Server baseline status details.
cond.ThresholdDefinition.Response
The response body of a HTTP GET request for the 'cond.ThresholdDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in…
cond.ThresholdDefinition.Relationship
A relationship to the 'cond.ThresholdDefinition' resource, or the expanded 'cond.ThresholdDefinition' resource, or the 'null' value.
cond.ThresholdDefinition
Defines the conditions to trigger a custom alarm. This has the information needed to construct and evaluate alarms.
cond.ThresholdDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.ThresholdDefinitionState
Defines the state of ThresholdDefinition objects, enabling alarm processing to be customized according to the specific needs.
connector.AuthMessage
A base abstract message for connector messages that require authentication to be passed from the Intersight services.
connector.BaseMessage
A base abstract message that handles the common request properties applicable to all message types.
connector.CacheStatus
The status of a cache operation. The cache plugin will report the status of a caching operation periodically to report status or to report completion/error.
connector.CloseStreamMessage
Close a running stream. After close the stream will no longer emit events or be available to write to.
connector.CommandControlMessage
A Command Message is sent from a cloud service to the connector's command plugin to execute a given command on the platform and begin tunneling input/output to…
connector.CommandTerminalStream
Holds the I/O of a terminal command session.
connector.DownloadStatus
The status of a download operation. The download plugin will report the status of a download operation periodically to report status or to report completion/er…
connector.EncryptionTaskMessage
An abstract message that handles properties required to receive encrypted data.
connector.EventLog
A message to inform platform about any config changes.
connector.ExpectPrompt
This models a single expect and answer prompt of the interactive command.
connector.FetchStreamMessage
Retrieve a list of cached stream messages by stream id. Cloud services will request stream messages to be re-sent in case of dropped messages (the cloud servic…
connector.FileChecksum
A checksum value of a file's contents. Used to verify the integrity or equality of files on the file system.
connector.FileMessage
Message carries file operations to perform on the platform's file system. Cloud services can send a message to open and write to files on the connector platfor…
connector.HttpRequest
An HTTP request sent by a cloud service to be proxied through a device connector.
connector.PlatformParamBase
Parameter object for Tech Support requests. PlatformParamBase is the base class for the platform-specific parameter types.
connector.ScopedInventory
Abstract object defined to handle scoped inventory for a set of objects identified by the query parameters defined in the properties. All vendor specific scope…
connector.SshConfig
Carries the SSH session details for opening a new connection. Sent by cloud services with the OpenSession message.
connector.SshMessage
An SSH message for opening, closing, executing a command, fetching or writing a file to a remote server. Cloud services send this message to a connector's SSH…
connector.StartStream
Start a stream. Cloud services sends the configuration for a stream to be opened within this message. If there already exists a stream with the given ID the co…
connector.StartStreamFromDevice
Start a stream from the device connector. Message type sent from the device connector to Intersight to trigger a stream open.
connector.StreamAcknowledge
Acknowledge a set of messages read from the device, on receipt device will drop the acknowledged messages from its cache.
connector.StreamInput
Write input to a running stream. Cloud services can send input to a running stream. e.g. input to a running pseudoterminal If the requested stream is not runni…
connector.StreamKeepalive
Keepalive message sent between service and device over lifetime of stream. Cloud services will configure device to emit message periodically. On receipt cloud…
connector.StreamMessage
The base message to be sent to the stream plugin. Carries information to route the message to the appropriate running stream or create a new stream.
connector.TargetChangeMessage
The message sent to the Appliance device connector when a Target is created, modified or deleted. Appliance device connector is expected to maintain a durable…
connector.TargetSpecification
Target deployment specification details to deploy target as a kube service. This allows Intersight to define supported docker image tag and customize resources…
connector.Url
The URL to proxy the request to.
connector.WinrmRequest
A WinRM message sent from a cloud service to be proxied through a device connector. Encapsulates the details needed to execute a powershell script against an I…
connector.XmlApiMessage
Carries an XML API request to an HTTP server running on the platform.
content.BaseParameter
A Baseparameter is an abstract definition of specific value to be extracted from a given API or device response. The BaseParameter object provides the name, ty…
content.ComplexType
If the given API/device response is a collection of items, each item and its properties can be modeled as a complex type. The types are uniquely named within t…
content.Parameter
Concrete implementation of BaseParameter for XML and JSON content types.
content.TextParameter
Concrete implementation of BaseParameter for Text content.
coremanagement.CoreFile.Response
The response body of a HTTP GET request for the 'coremanagement.CoreFile' resource. The value may be one of the following types. 1. When 'tag' is specified in…
coremanagement.CoreFile.Relationship
A relationship to the 'coremanagement.CoreFile' resource, or the expanded 'coremanagement.CoreFile' resource, or the 'null' value.
coremanagement.CoreFile
Core file meta data for individual core files on device.
coremanagement.CoreFile.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
coremanagement.Download.Response
The response body of a HTTP GET request for the 'coremanagement.Download' resource. The value may be one of the following types. 1. When 'tag' is specified in…
coremanagement.Download
Download the core file. The response to this API will be the actual core file.
coremanagement.Download.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
externalsite.Authorization.Response
The response body of a HTTP GET request for the 'externalsite.Authorization' resource. The value may be one of the following types. 1. When 'tag' is specified…
externalsite.Authorization
An authentication request that will be used to get authorized from external repository like cisco.com in order to download the image. This MO creation is a one…
externalsite.Authorization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
filterexpr.AndFilterExpression
All child expressions must match.
filterexpr.FilterExpression
Shared boolean filter tree. Inner nodes are conjunctions or disjunctions; leaves are predicate nodes. Services embed or reference this abstraction for domain-s…
filterexpr.OrFilterExpression
At least one child expression must match.
filterexpr.PredicateFilterExpression
A single predicate (property, operator, values) with optional managed-object reference for invalidation or display resolution.
hci.AhvGuestTools
The details of the Nutanix Guest Tools.
hci.AhvVm.Response
The response body of a HTTP GET request for the 'hci.AhvVm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
hci.AhvVm.Relationship
A relationship to the 'hci.AhvVm' resource, or the expanded 'hci.AhvVm' resource, or the 'null' value.
hci.AhvVm
An AHV VM reported by Prism Central.
hci.AhvVm.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.AhvVmDisk.Response
The response body of a HTTP GET request for the 'hci.AhvVmDisk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
hci.AhvVmDisk.Relationship
A relationship to the 'hci.AhvVmDisk' resource, or the expanded 'hci.AhvVmDisk' resource, or the 'null' value.
hci.AhvVmDisk
A disk associated with an AHV VM.
hci.AhvVmDisk.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.AhvVmGpu.Response
The response body of a HTTP GET request for the 'hci.AhvVmGpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
hci.AhvVmGpu.Relationship
A relationship to the 'hci.AhvVmGpu' resource, or the expanded 'hci.AhvVmGpu' resource, or the 'null' value.
hci.AhvVmGpu
A GPU associated with an AHV VM.
hci.AhvVmGpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.AhvVmNic.Response
The response body of a HTTP GET request for the 'hci.AhvVmNic' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
hci.AhvVmNic.Relationship
A relationship to the 'hci.AhvVmNic' resource, or the expanded 'hci.AhvVmNic' resource, or the 'null' value.
hci.AhvVmNic
A NIC associated with an AHV VM.
hci.AhvVmNic.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.Alarm.Response
The response body of a HTTP GET request for the 'hci.Alarm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
hci.Alarm
An alert from an HCI cluster reported from the Prism Central serviceability/Alerts API.
hci.Alarm.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.AlarmParameter
The key value pair of parameters from the endpoint alarm object to populate the fields in the title and message properties.
hci.AlarmSummary
The summary of alarm counts based on alarm severity.
hci.ApiLimit
The limit info about an Nutanix API. Once the limit is reached, the API will return incomplete results.
hci.BackplaneNetworkParams
The backplane network parameters.
hci.BaseVm.Relationship
A relationship to the 'hci.BaseVm' resource, or the expanded 'hci.BaseVm' resource, or the 'null' value.
hci.BaseVm
A base VM reported by Prism Central.
hci.CapacityViolation
The violation of a capacity.
hci.Cluster.Response
The response body of a HTTP GET request for the 'hci.Cluster' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
hci.Cluster.Relationship
A relationship to the 'hci.Cluster' resource, or the expanded 'hci.Cluster' resource, or the 'null' value.
hci.Cluster
The Cluster object represents a cluster, as reported by Nutanix Prism Central. This provides a structured representation of clusters, including their configura…
hci.Cluster.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.ClusterOpInfo
Status tracking information for a specific cluster operation type (e.g., NCC check).
hci.ClusterOperation.Response
The response body of a HTTP GET request for the 'hci.ClusterOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
hci.ClusterOperation.Relationship
A relationship to the 'hci.ClusterOperation' resource, or the expanded 'hci.ClusterOperation' resource, or the 'null' value.
hci.ClusterOperation
The ClusterOperation object is an inventory managed object that allows users to trigger and track cluster-level operations such as NCC checks, configuration ch…
hci.ClusterOperation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.Compliance.Response
The response body of a HTTP GET request for the 'hci.Compliance' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
hci.Compliance.Relationship
A relationship to the 'hci.Compliance' resource, or the expanded 'hci.Compliance' resource, or the 'null' value.
hci.Compliance
The Compliance object offers a comprehensive view of licensing compliance within clusters, as reported by Nutanix Prism Central. Purpose The Compliance object…
hci.Compliance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.ConfigurableParamValue
Value for a configurable parameter.
hci.ConfigurableParamValueRange
Valid value range for a configurable parameter.
hci.Consumption
A license's consumption detail by a cluster.
hci.Disk.Response
The response body of a HTTP GET request for the 'hci.Disk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
hci.Disk.Relationship
A relationship to the 'hci.Disk' resource, or the expanded 'hci.Disk' resource, or the 'null' value.
hci.Disk
The physical disk belonging to a node in a Nutanix cluster. Purpose The Disk object provides a detailed view of disk configurations. Key Concepts - Configurati…
hci.Disk.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.DomainManager.Response
The response body of a HTTP GET request for the 'hci.DomainManager' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
hci.DomainManager.Relationship
A relationship to the 'hci.DomainManager' resource, or the expanded 'hci.DomainManager' resource, or the 'null' value.
hci.DomainManager
The DomainManager object represents the Nutanix Prism Central instance managing multiple clusters. Purpose The DomainManager object reports basic information a…
hci.DomainManager.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.Entitlement.Response
The response body of a HTTP GET request for the 'hci.Entitlement' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
hci.Entitlement.Relationship
A relationship to the 'hci.Entitlement' resource, or the expanded 'hci.Entitlement' resource, or the 'null' value.
hci.Entitlement
The Entitlement object captures the details of license entitlements associated with clusters. This provides a structured representation of entitlement informat…
hci.Entitlement.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.EntitlementDetail
The detail of a license entitlement detail.
hci.EsxiGuestTools
The details of the Nutanix Guest Tools.
hci.EsxiVm.Response
The response body of a HTTP GET request for the 'hci.EsxiVm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
hci.EsxiVm.Relationship
A relationship to the 'hci.EsxiVm' resource, or the expanded 'hci.EsxiVm' resource, or the 'null' value.
hci.EsxiVm
An ESXi VM reported by Prism Central.
hci.EsxiVm.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.EsxiVmDisk.Response
The response body of a HTTP GET request for the 'hci.EsxiVmDisk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
hci.EsxiVmDisk.Relationship
A relationship to the 'hci.EsxiVmDisk' resource, or the expanded 'hci.EsxiVmDisk' resource, or the 'null' value.
hci.EsxiVmDisk
A disk associated with an ESXi VM.
hci.EsxiVmDisk.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.EsxiVmNic.Response
The response body of a HTTP GET request for the 'hci.EsxiVmNic' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
hci.EsxiVmNic.Relationship
A relationship to the 'hci.EsxiVmNic' resource, or the expanded 'hci.EsxiVmNic' resource, or the 'null' value.
hci.EsxiVmNic
A NIC associated with an ESXi VM.
hci.EsxiVmNic.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.ExpiredLicense
The details of the expired license.
hci.ExternalStorage.Response
The response body of a HTTP GET request for the 'hci.ExternalStorage' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
hci.ExternalStorage.Relationship
A relationship to the 'hci.ExternalStorage' resource, or the expanded 'hci.ExternalStorage' resource, or the 'null' value.
hci.ExternalStorage
An external storage instance represents storage provided by external vendors such as Pure Storage that is used by Nutanix clusters. Purpose The ExternalStorage…
hci.ExternalStorage.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.ExternalStorageArray
Information about a Pure Storage FlashArray that provides external storage to a Nutanix cluster.
hci.FaultToleranceState
The state of fault tolerance of a cluster.
hci.FeatureViolation
The detailed violation of a feature.
hci.Gpu.Response
The response body of a HTTP GET request for the 'hci.Gpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, t…
hci.Gpu.Relationship
A relationship to the 'hci.Gpu' resource, or the expanded 'hci.Gpu' resource, or the 'null' value.
hci.Gpu
A GPU belonging to a node in a Nutanix cluster. Purpose The Gpu object provides a detailed view of GPU configuration for a node in a Nutanix cluster. Key Conce…
hci.Gpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.IpAddress
An IP address that can be either IPv4 or IPv6.
hci.IpAddressOrFqdn
An IP address that can be either IPv4 or IPv6.
hci.KeyManagementDeviceToCertStatusInfo
The status of the certificate on the key management device.
hci.License.Response
The response body of a HTTP GET request for the 'hci.License' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
hci.License.Relationship
A relationship to the 'hci.License' resource, or the expanded 'hci.License' resource, or the 'null' value.
hci.License
The License object captures the details of software licenses acquired by Nutanix Prism Central. This provides a structured representation of licenses for all e…
hci.License.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.LicensedService
The compliance state of a licensed service.
hci.ManagementServer
The management server of a cluster.
hci.NccCheckPolicy.Response
The response body of a HTTP GET request for the 'hci.NccCheckPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
hci.NccCheckPolicy
A Nutanix Cluster Check (NCC) policy configured on the Prism Central.
hci.NccCheckPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.NccConfigurableParameter
NCC policy parameters that is configurable by a user.
hci.Node.Response
The response body of a HTTP GET request for the 'hci.Node' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
hci.Node.Relationship
A relationship to the 'hci.Node' resource, or the expanded 'hci.Node' resource, or the 'null' value.
hci.Node
The Node object encapsulates the details of individual nodes within clusters, as reported by Nutanix Prism Central. This provides a structured representation o…
hci.Node.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.NutanixClusterCheck
Configuration for Nutanix Cluster Check (NCC) operation. NCC is a diagnostic tool that validates cluster health.
hci.PendingWorkflowTrigger
Tracking entry for an async workflow trigger awaiting callback response.
hci.PhysicalGpu.Response
The response body of a HTTP GET request for the 'hci.PhysicalGpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
hci.PhysicalGpu.Relationship
A relationship to the 'hci.PhysicalGpu' resource, or the expanded 'hci.PhysicalGpu' resource, or the 'null' value.
hci.PhysicalGpu
Physical GPU managed by a cluster and reported by Prism Central.
hci.PhysicalGpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.PulseStatus
The pulse status of a cluster.
hci.Sbdf
The Segment:Bus:Device.Function (SBDF) hardware address.
hci.SdaPolicyClusterConfig
NCC Policy parameters for specific cluster.
hci.ServiceViolation
A instance of a service violation.
hci.SoftwareType
The type and version information of a software.
hci.StorageContainer.Response
The response body of a HTTP GET request for the 'hci.StorageContainer' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
hci.StorageContainer.Relationship
A relationship to the 'hci.StorageContainer' resource, or the expanded 'hci.StorageContainer' resource, or the 'null' value.
hci.StorageContainer
Storage containers in Nutanix serve as logical abstraction layers for virtual disk storage which can be backed by HCI (local) storage or external storage provi…
hci.StorageContainer.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.Violation.Response
The response body of a HTTP GET request for the 'hci.Violation' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
hci.Violation.Relationship
A relationship to the 'hci.Violation' resource, or the expanded 'hci.Violation' resource, or the 'null' value.
hci.Violation
The Violation object identifies instances of license violations within Nutanix Prism Central. This provides information for tracking license violation issues.…
hci.Violation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.VirtualGpu.Response
The response body of a HTTP GET request for the 'hci.VirtualGpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
hci.VirtualGpu.Relationship
A relationship to the 'hci.VirtualGpu' resource, or the expanded 'hci.VirtualGpu' resource, or the 'null' value.
hci.VirtualGpu
Virtual GPU managed by a cluster and reported by Prism Central.
hci.VirtualGpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.VirtualGpuConfig
The configuration of a virtual GPU.
hcl.CompatibilityStatus
The CompatibilityStatus object evaluates the compatibility of hardware and software configurations within the system. This provides insights into the compatibi…
hcl.Constraint
A key value pair, determining a compatibility constraint for the matching version combinations.
hcl.DataImportLog.Response
The response body of a HTTP GET request for the 'hcl.DataImportLog' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
hcl.DataImportLog
The DataImportLog object serves as a record-keeping tool for tracking the data import processes from the HCL tool. This provides transparency and accountabilit…
hcl.DataImportLog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.DriverImage.Response
The response body of a HTTP GET request for the 'hcl.DriverImage' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
hcl.DriverImage
Collection used to store the driver ISO urls for each server based on how it is managed.
hcl.DriverImage.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.ExemptedCatalog.Response
The response body of a HTTP GET request for the 'hcl.ExemptedCatalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
hcl.ExemptedCatalog
Collection used to store exempted products (ie. adapters, storage controllers, etc). These products should be ignored for HCL validation purposes.
hcl.ExemptedCatalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.Firmware
Model which holds the details of firmware version and driver version.
hcl.HardwareCompatibilityProfile
Profile giving server hardware details, OS details and UCS Version details.
hcl.HwCatalogInfo.Response
The response body of a HTTP GET request for the 'hcl.HwCatalogInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
hcl.HwCatalogInfo.Relationship
A relationship to the 'hcl.HwCatalogInfo' resource, or the expanded 'hcl.HwCatalogInfo' resource, or the 'null' value.
hcl.HwCatalogInfo
Hardware catalog information for HyperFlex Data Platform, required for BOM validation.
hcl.HwCatalogInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.HyperflexSoftwareCompatibilityInfo.Response
The response body of a HTTP GET request for the 'hcl.HyperflexSoftwareCompatibilityInfo' resource. The value may be one of the following types. 1. When 'tag' i…
hcl.HyperflexSoftwareCompatibilityInfo.Relationship
A relationship to the 'hcl.HyperflexSoftwareCompatibilityInfo' resource, or the expanded 'hcl.HyperflexSoftwareCompatibilityInfo' resource, or the 'null' value.
hcl.HyperflexSoftwareCompatibilityInfo
Lists software compatibility information between different HperFlex component versions like HyperFlex Data Platform, Hypervisor, Drive Firmware, etc.
hcl.HyperflexSoftwareCompatibilityInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.OperatingSystem.Response
The response body of a HTTP GET request for the 'hcl.OperatingSystem' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
hcl.OperatingSystem.Relationship
A relationship to the 'hcl.OperatingSystem' resource, or the expanded 'hcl.OperatingSystem' resource, or the 'null' value.
hcl.OperatingSystem
Collection used to store operating system details.
hcl.OperatingSystem.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.OperatingSystemVendor.Response
The response body of a HTTP GET request for the 'hcl.OperatingSystemVendor' resource. The value may be one of the following types. 1. When 'tag' is specified i…
hcl.OperatingSystemVendor.Relationship
A relationship to the 'hcl.OperatingSystemVendor' resource, or the expanded 'hcl.OperatingSystemVendor' resource, or the 'null' value.
hcl.OperatingSystemVendor
Collection used to store operating system vendors details.
hcl.OperatingSystemVendor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.Product
Model giving the details of product.
hcl.ServerCatalog.Response
The response body of a HTTP GET request for the 'hcl.ServerCatalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
hcl.ServerCatalog
Collection used to store the server catalog information. This contails details about all the supported cpu models for the selected Server model.
hcl.ServerCatalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.ServerConfiguration
Changes to the server configuration that occurred during the most recent incremental import of HCL data.
hcl.ServerHwCatalogInfo.Response
The response body of a HTTP GET request for the 'hcl.ServerHwCatalogInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in…
hcl.ServerHwCatalogInfo.Relationship
A relationship to the 'hcl.ServerHwCatalogInfo' resource, or the expanded 'hcl.ServerHwCatalogInfo' resource, or the 'null' value.
hcl.ServerHwCatalogInfo
Server hardware catalog information for a particular server model, used for server BOM validation.
hcl.ServerHwCatalogInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.SupportedDriverName
The SupportedDriverName object facilitates the identification and management of driver names supported for specific products and operating systems. It plays a…
i18n.Message
An i18n message that can be translated in multiple languages to support internationalization. An i18n message includes a unique message identifier, a text form…
i18n.MessageParam
A key, value pair used to substitute variables when translating a message in a particular locale for internationalization purpose.
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.
imcconnector.WebUiMessage
Message contains the request to send to the platforms management entities HTTP server. Returns the HTTP response body from the platform, or error if plugin enc…
infra.BaseCluster.Relationship
A relationship to the 'infra.BaseCluster' resource, or the expanded 'infra.BaseCluster' resource, or the 'null' value.
infra.BaseCluster
Common attributes of a cluster of resources within a datacenter. A cluster is a convenient grouping of resources such as Host, Datastore, etc.
infra.BaseGpuConfiguration
Common GPU configuration on a compute resource (BM or VM).
infra.BasePciConfiguration
Common PCI device configuration on a compute resource (BareMetal - BM, or VirtualMachine - VM).
infra.GpuConfiguration
Generic GPU configuration on a compute resource (BM or VM).
infra.HardwareInfo
Information about the hardware platform (cpu, memory).
infra.MetaData
User defined entity label for identifying resource.
infra.MigGpuConfiguration
Nvidia MIG capable GPU configuration on a compute resource (BM or VM).
issue.Condition
Condition defines the set of criteria under which an issue exists.
issue.Definition
The definition of an issue which encompases the criteria for identifying when the issue exists, documentation of the detected issue, and actions to be taken by…
issue.DeviceTag
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.
issue.Message
A message which is optionally parameterized and which supports language localization.
issue.OdataCondition
OdataCondition defines, via an Odata predicate, a set of criteria under which an issue exists.
iwotenant.MaintenanceNotification.Response
The response body of a HTTP GET request for the 'iwotenant.MaintenanceNotification' resource. The value may be one of the following types. 1. When 'tag' is spe…
iwotenant.MaintenanceNotification
MaintenanceNotifications represent maintenance-related messages intended to be shown to users as a UI banner when they log in. The notification is scoped to an…
iwotenant.MaintenanceNotification.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iwotenant.Migrate.Response
The response body of a HTTP GET request for the 'iwotenant.Migrate' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iwotenant.Migrate
Migrates provide an API surface to transfer a customer's IWO data, including the information required to stage migration artifacts (for example, an S3 URL) and…
iwotenant.Migrate.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iwotenant.TenantCustomization.Response
The response body of a HTTP GET request for the 'iwotenant.TenantCustomization' resource. The value may be one of the following types. 1. When 'tag' is specifi…
iwotenant.TenantCustomization
The TenantCustomization object allows end-users to tailor their IWO tenant configurations, enhancing functionality through options like enabling data extractor…
iwotenant.TenantCustomization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iwotenant.TenantStatus.Response
The response body of a HTTP GET request for the 'iwotenant.TenantStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
iwotenant.TenantStatus
TenantStatuses provide a customer-visible status and health indicator for IWO tenant provisioning. Because IWO features depend on the tenant namespace becoming…
iwotenant.TenantStatus.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…
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.
metric.SeverityCriteria
Defines how different levels of alarm severity correspond to specific threshold values for metrics.
metric.ThresholdCondition
The criteria set by the user to identify issue in timeseries metric data.
metric.ThresholdDefinitionState
Defines the state of metric related ThresholdDefinition objects, enabling alarm processing to be customized according to the specific needs.
metrics.Configuration.Response
The response body of a HTTP GET request for the 'metrics.Configuration' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
metrics.Configuration
Controls the behavior of metric collection for an account, configuration includes options to enable or disable collection as well how new devices claimed to th…
metrics.Configuration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
metrics.MetricCriterion
Data and parameters for metric configuration.
metrics.MetricsExploration.Response
The response body of a HTTP GET request for the 'metrics.MetricsExploration' resource. The value may be one of the following types. 1. When 'tag' is specified…
metrics.MetricsExploration
The MetricsExploration object is pivotal for querying and analyzing metrics data within the system. This provides a structured approach to defining and executi…
metrics.MetricsExploration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
metrics.ResourceConfiguration.Response
The response body of a HTTP GET request for the 'metrics.ResourceConfiguration' resource. The value may be one of the following types. 1. When 'tag' is specifi…
metrics.ResourceConfiguration
The configuration of metric collection for a given resource within an account. Each resource that is capable of collecting metrics into the Intersight system m…
metrics.ResourceConfiguration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.BackupCategory.Response
The response body of a HTTP GET request for the 'mgmt.BackupCategory' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
mgmt.BackupCategory.Relationship
A relationship to the 'mgmt.BackupCategory' resource, or the expanded 'mgmt.BackupCategory' resource, or the 'null' value.
mgmt.BackupCategory
Meta data information used by the backup service to classify backup of MO types.
mgmt.BackupCategory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.BackupOptions
Options to control the behavior of a backup operation.
mgmt.CategoryExportData
Information regarding export jobs that are triggered for a category of objects.
mgmt.CategoryImportData
Information regarding import jobs that are triggered for a category of objects.
mgmt.ChildTypeInfo
Child type information for a parent type.
mgmt.ConfigBackupFile.Response
The response body of a HTTP GET request for the 'mgmt.ConfigBackupFile' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
mgmt.ConfigBackupFile.Relationship
A relationship to the 'mgmt.ConfigBackupFile' resource, or the expanded 'mgmt.ConfigBackupFile' resource, or the 'null' value.
mgmt.ConfigBackupFile
A configuration backup file that user can upload in Intersight so that the uploaded backup can be restored in Intersight when needed.
mgmt.ConfigBackupFile.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.ConfigBackupInstance.Response
The response body of a HTTP GET request for the 'mgmt.ConfigBackupInstance' resource. The value may be one of the following types. 1. When 'tag' is specified i…
mgmt.ConfigBackupInstance.Relationship
A relationship to the 'mgmt.ConfigBackupInstance' resource, or the expanded 'mgmt.ConfigBackupInstance' resource, or the 'null' value.
mgmt.ConfigBackupInstance
The ConfigBackupInstance object represents a stored backup artifact in the system repository. It is the consumable backup unit that can be protected, downloade…
mgmt.ConfigBackupInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.ConfigBackupOperation.Response
The response body of a HTTP GET request for the 'mgmt.ConfigBackupOperation' resource. The value may be one of the following types. 1. When 'tag' is specified…
mgmt.ConfigBackupOperation.Relationship
A relationship to the 'mgmt.ConfigBackupOperation' resource, or the expanded 'mgmt.ConfigBackupOperation' resource, or the 'null' value.
mgmt.ConfigBackupOperation
The ConfigBackupOperation object represents an administrator-initiated configuration backup run. This provides a single, traceable record for when a backup was…
mgmt.ConfigBackupOperation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.ConfigCategorySummary.Response
The response body of a HTTP GET request for the 'mgmt.ConfigCategorySummary' resource. The value may be one of the following types. 1. When 'tag' is specified…
mgmt.ConfigCategorySummary
The ConfigCategorySummary object provides a categorized summary of what was captured in a backup instance. It is structured to help customers understand covera…
mgmt.ConfigCategorySummary.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.ConfigObjectDetails
The details of the object backed up or restored.
mgmt.ConfigObjectRestoreDetails
The details about the object restored.
mgmt.ConfigOperationSetting.Response
The response body of a HTTP GET request for the 'mgmt.ConfigOperationSetting' resource. The value may be one of the following types. 1. When 'tag' is specified…
mgmt.ConfigOperationSetting
The ConfigOperationSetting object represents account-level settings that support configuration backup and restore operations. It centralizes operational config…
mgmt.ConfigOperationSetting.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.ConfigRestoreCategorySummary.Response
The response body of a HTTP GET request for the 'mgmt.ConfigRestoreCategorySummary' resource. The value may be one of the following types. 1. When 'tag' is spe…
mgmt.ConfigRestoreCategorySummary
The ConfigRestoreCategorySummary object provides a categorized view of what is being restored (and what was restored) as part of a restore operation. It suppor…
mgmt.ConfigRestoreCategorySummary.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.ConfigRestoreOperation.Response
The response body of a HTTP GET request for the 'mgmt.ConfigRestoreOperation' resource. The value may be one of the following types. 1. When 'tag' is specified…
mgmt.ConfigRestoreOperation.Relationship
A relationship to the 'mgmt.ConfigRestoreOperation' resource, or the expanded 'mgmt.ConfigRestoreOperation' resource, or the 'null' value.
mgmt.ConfigRestoreOperation
The ConfigRestoreOperation object represents an administrator-initiated configuration restore run. It tracks the end-to-end process of applying a previously ca…
mgmt.ConfigRestoreOperation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.ObjectBackupMeta.Response
The response body of a HTTP GET request for the 'mgmt.ObjectBackupMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
mgmt.ObjectBackupMeta
Meta data information used by the backup service to control the backup of MO types.
mgmt.ObjectBackupMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.OrgBackupOperation.Response
The response body of a HTTP GET request for the 'mgmt.OrgBackupOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in…
mgmt.OrgBackupOperation.Relationship
A relationship to the 'mgmt.OrgBackupOperation' resource, or the expanded 'mgmt.OrgBackupOperation' resource, or the 'null' value.
mgmt.OrgBackupOperation
The OrgBackupOperation object represents the organization-scoped portion of a broader configuration backup run. This provides visibility into how backup proces…
mgmt.OrgBackupOperation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.OrgRestoreOperation.Response
The response body of a HTTP GET request for the 'mgmt.OrgRestoreOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in…
mgmt.OrgRestoreOperation.Relationship
A relationship to the 'mgmt.OrgRestoreOperation' resource, or the expanded 'mgmt.OrgRestoreOperation' resource, or the 'null' value.
mgmt.OrgRestoreOperation
An organization-scoped portion of a configuration restore run with a dedicated view into how a restore is applied per organization, including sequencing and st…
mgmt.OrgRestoreOperation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mgmt.RestoreOptions
Options to control the behavior of a restore operation.
mgmt.TypeWithFilter
Object type along with filter information.
mo.BaseComplexType
object
BaseComplexType is a base abstract class for all complex types. All complex types inherit from this base type.
2 properties
3 required
mo.BaseMo.Relationship
A relationship to the 'mo.BaseMo' resource, or the expanded 'mo.BaseMo' resource, or the 'null' value.
mo.BaseMo
object
The base abstract class for all Cisco Intersight managed objects.
15 properties
3 required
mo.MoRef
object
A reference to a REST resource, uniquely identified by object type and Moid.
5 properties
3 required
mo.Tag
object
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.
7 properties
mo.VersionContext
VersionContext contains the versioning info for an object.
monitoring.CategoryStatus
Status of an Intersight category such as 'Licensing' with additional details. Several categories and their respective status is reported as part of the health…
monitoring.HealthStatus.Response
The response body of a HTTP GET request for the 'monitoring.HealthStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in…
monitoring.HealthStatus
High level, aggregated status of Intersight components for a given Intersight account user. Meant to inform the user if there's an issue with Intersight compon…
monitoring.HealthStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
motemplate.ActionEntry
An action entry that contains the action type and its associated action parameters as a key:value pair.
motemplate.ActionParam
An action parameter setting as a key/value pair.
motemplate.SyncError
The configuration error description while syncing a template object to its dervied object.
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.
onprem.ApplianceSystemInfo.Response
The response body of a HTTP GET request for the 'onprem.ApplianceSystemInfo' resource. The value may be one of the following types. 1. When 'tag' is specified…
onprem.ApplianceSystemInfo
ApplianceSystemInfo managed object stores the Intersight Appliance System information. It is created during the Intersight Appliance setup. It is updated perio…
onprem.ApplianceSystemInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
onprem.AuditRecord.Response
The response body of a HTTP GET request for the 'onprem.AuditRecord' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
onprem.AuditRecord
AuditRecord presents the configuration changes made by the user per transaction.
onprem.AuditRecord.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
onprem.ClusterInfo
ClusterInfo encapsulates properties of an Intersight Appliance. ClusterNode and ClusterInfo data structures are shared between the upgrade services running in…
onprem.ClusterNode
ClusterNode encapsulates the properties of an Intersight Appliance node (virtual machine). ClusterNode and ClusterInfo data structures are shared between the u…
onprem.ImagePackage
ImagePackage encapsulates a software image package. ImagePackage can be a docker image, a UI web image, an endpoint (e.g. UCSM) image, a device connector image…
onprem.ResourceInfo
Common data structure used for capturing memory or storage usage information.
onprem.Schedule
Schedule is used by Intersight Appliance services to store task scheduling information. For example, appliance backup service uses Schedule to store the backup…
onprem.Upgrade.Response
The response body of a HTTP GET request for the 'onprem.Upgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
onprem.Upgrade
Upgrade tracks the Intersight Appliance's software upgrades. Intersight Appliance's upgrade service automatically creates an Upgrade managed object when there…
onprem.Upgrade.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
onprem.UpgradeNote
UpgradeNote managed object contains the description of one feature/bug fix.
onprem.UpgradePhase
UpgradePhase represents a phase of the Intersight Appliance software upgrade process. This data structure is shared by both the Intersight upgrade service and…
onprem.UserPreference.Response
The response body of a HTTP GET request for the 'onprem.UserPreference' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
onprem.UserPreference
Holder for UI preferences such as theme, columns.
onprem.UserPreference.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.
partnerintegration.DcLogs.Response
The response body of a HTTP GET request for the 'partnerintegration.DcLogs' resource. The value may be one of the following types. 1. When 'tag' is specified i…
partnerintegration.DcLogs.Relationship
A relationship to the 'partnerintegration.DcLogs' resource, or the expanded 'partnerintegration.DcLogs' resource, or the 'null' value.
partnerintegration.DcLogs
The DcLogs object captures the standard output and error logs generated during the build operations of a device connector. Purpose This provides visibility int…
partnerintegration.DcLogs.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.DeviceConnector.Response
The response body of a HTTP GET request for the 'partnerintegration.DeviceConnector' resource. The value may be one of the following types. 1. When 'tag' is sp…
partnerintegration.DeviceConnector.Relationship
A relationship to the 'partnerintegration.DeviceConnector' resource, or the expanded 'partnerintegration.DeviceConnector' resource, or the 'null' value.
partnerintegration.DeviceConnector
The DeviceConnectors object acts as a recipe for building and deploying device connector services on an appliance. Purpose It manages the lifecycle of device c…
partnerintegration.DeviceConnector.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.DocIssues.Response
The response body of a HTTP GET request for the 'partnerintegration.DocIssues' resource. The value may be one of the following types. 1. When 'tag' is specifie…
partnerintegration.DocIssues.Relationship
A relationship to the 'partnerintegration.DocIssues' resource, or the expanded 'partnerintegration.DocIssues' resource, or the 'null' value.
partnerintegration.DocIssues
The DocIssues object captures documentation-related issues identified during the build operation of an inventory collection. Purpose This provides feedback on…
partnerintegration.DocIssues.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.Etl.Response
The response body of a HTTP GET request for the 'partnerintegration.Etl' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
partnerintegration.Etl.Relationship
A relationship to the 'partnerintegration.Etl' resource, or the expanded 'partnerintegration.Etl' resource, or the 'null' value.
partnerintegration.Etl
The Etls object defines the transformation logic used to translate platform-specific API outputs into Intersight-managed objects. Purpose It serves as the tran…
partnerintegration.Etl.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.File.Response
The response body of a HTTP GET request for the 'partnerintegration.File' resource. The value may be one of the following types. 1. When 'tag' is specified in…
partnerintegration.File
The PartnerIntegrationFile object is a partner integration artifact, containing development code uploaded by partners for building DC/microservices. It support…
partnerintegration.File.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.Inventory.Response
The response body of a HTTP GET request for the 'partnerintegration.Inventory' resource. The value may be one of the following types. 1. When 'tag' is specifie…
partnerintegration.Inventory.Relationship
A relationship to the 'partnerintegration.Inventory' resource, or the expanded 'partnerintegration.Inventory' resource, or the 'null' value.
partnerintegration.Inventory
Inventory Collection object that acts as an aggregator object for the underlying model and ETL objects.
partnerintegration.Inventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.Logs.Response
The response body of a HTTP GET request for the 'partnerintegration.Logs' resource. The value may be one of the following types. 1. When 'tag' is specified in…
partnerintegration.Logs.Relationship
A relationship to the 'partnerintegration.Logs' resource, or the expanded 'partnerintegration.Logs' resource, or the 'null' value.
partnerintegration.Logs
The Logs object captures the standard output and error logs generated during the build operation of an inventory collection. Purpose Similar to DcLogs, this ob…
partnerintegration.Logs.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.Metrics.Response
The response body of a HTTP GET request for the 'partnerintegration.Metrics' resource. The value may be one of the following types. 1. When 'tag' is specified…
partnerintegration.Metrics.Relationship
A relationship to the 'partnerintegration.Metrics' resource, or the expanded 'partnerintegration.Metrics' resource, or the 'null' value.
partnerintegration.Metrics
The Metrics object defines how platform API outputs are translated into the Intersight Metrics format. Purpose It allows for the transformation of raw platform…
partnerintegration.Metrics.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
partnerintegration.MetricsModel
Transformation model in metrics format.
partnerintegration.Model.Response
The response body of a HTTP GET request for the 'partnerintegration.Model' resource. The value may be one of the following types. 1. When 'tag' is specified in…
partnerintegration.Model.Relationship
A relationship to the 'partnerintegration.Model' resource, or the expanded 'partnerintegration.Model' resource, or the 'null' value.
partnerintegration.Model
The Model object defines the endpoint model used for inventory collections. Purpose This provides the schema definition for the inventory endpoints, ensuring t…
partnerintegration.Model.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
pkix.DistinguishedName
The identifier for the owner of an X.509 certificate and the authority that issued the certificate.
pkix.EcdsaKeySpec
The key pair is generated using Elliptic Curve Digital Signature Algorithm (ECDSA), as defined in FIPS 186-4. The ECDSA standard was originally developed for t…
pkix.EddsaKeySpec
The key pair is generated using Edwards-Curve Digital Signature Algorithm (EdDSA). The Edwards-curve Digital Signature Algorithm (EdDSA) is a variant of Schnor…
pkix.KeyGenerationSpec
The key generation spec provides the algorithm and the parameters required for this algorithm to generate a key.
pkix.RsaAlgorithm
The key pair is generated using the RSA algorithm and specified parameters.
pkix.SubjectAlternateName
The additional hostnames to be protected by a given X.509 certificate.
policy.AbstractConfigChangeDetail
Defines the details of a configuration change including change type, disruption and description of the change.
policy.AbstractConfigProfile.Relationship
A relationship to the 'policy.AbstractConfigProfile' resource, or the expanded 'policy.AbstractConfigProfile' resource, or the 'null' value.
policy.AbstractConfigProfile
AbstractConfigProfile is an abstract base type for all config actions on a profile.
policy.AbstractConfigResult
The results with the overall state and detailed result messages.
policy.AbstractConfigResultEntry
The results details information.
policy.AbstractConfigurationObject
Abstract base type for all configuration objects. All logical objects like profiles, policies, policy items like vnic, vhba and templates extend from this type…
policy.AbstractDisruption
Base class of all disruption types.
policy.AbstractInventory
A base abstract class used to represent all inventoried objects from a profile associated resource.
policy.AbstractPendingChangeEval
A base abstract class that captures the details of a pending policy change evaluation.
policy.AbstractPolicy.Relationship
A relationship to the 'policy.AbstractPolicy' resource, or the expanded 'policy.AbstractPolicy' resource, or the 'null' value.
policy.AbstractPolicy
A base abstract class for all configuration policies that can be applied to service profiles.
policy.AbstractPolicyInventory
A base abstract class for all Inventoried policies that can be applied to profiles.
policy.AbstractPolicyItem
A base abstract class for all child MOs of a policy, eg. vNIC in LAN connectivity policy and vHBA in SAN connectivity policy.
policy.AbstractProfile.Relationship
A relationship to the 'policy.AbstractProfile' resource, or the expanded 'policy.AbstractProfile' resource, or the 'null' value.
policy.AbstractProfile
Abstract base type for all profiles.
policy.ActionParam
An action parameter setting as a key/value pair.
policy.ActionQualifier
Action qualifiers can be used to control actions that are performed on a profile object. For example - perform a 'Deploy' action only for specific policies.
policy.ConfigChange
Defines the configuration changes at the summary level including configuration changes and disruptions.
policy.ConfigChangeContext
Initial configuration state snapshot and configuration state.
policy.ConfigChangeDetailType
Defines the details of a configuration change including change type, disruption and description of the change.
policy.ConfigChangeDisruptionDetailType
Details of the configuration change that includes type and description of the change and the type of disruption.
policy.ConfigContext
Configuration related state and results.
policy.ConfigResultContext
The context for a validation/config result such as the related entity's name, type, MOID etc.
policy.PolicyContextHolder
To store the policy details along with the context for which the entry is established.
policy.PolicyError
The PolicyError object captures errors that occur when adding or removing a policy from a profile or template. It is an integral part of policy management, pro…
policy.PolicyStatus
The status descriptor for any policy association or validation related to a profile/template. It contains the policy details like moid and type and the status…
policy.Qualifier
Qualifiers to control the action being triggered.
policy.ReportedPolicyChange
A policy change that has been reported to a profile.
policy.ScheduledAction
Scheduled Action enables the queuing of multiple profile actions to be executed sequentially. Each action in the sequence is executed only after the successful…
pool.AbstractBlock
Abstract base counters for a block of identifiers.
pool.AbstractBlockLease
BlockLease represents a block of address that is allocated from a pool to a specific entity like server profile/ vNic's or vhba's.
pool.AbstractBlockType
Abstract base class for a block of identifiers.
pool.AbstractIdPoolMember
A single member of an identity pool such as IP, MAC, UUID etc.
pool.AbstractLease
Concrete Children of Abstract Lease represent a single ID that is part of an ID universe. Concrete Children of this class will implement ID request action.
pool.AbstractPool
Pool represents a collection of identifiers that can be allocated to server profiles.
pool.AbstractPoolMember
A single entity that is part of a pool like a resource in a resource pool or an ID in an identity pool such as IP, MAC, UUID etc.
pool.IdMappingMember.Response
The response body of a HTTP GET request for the 'pool.IdMappingMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
pool.IdMappingMember
A resolved member of the ID mapping policy.
pool.IdMappingMember.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
pool.IdMappingPolicy.Response
The response body of a HTTP GET request for the 'pool.IdMappingPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
pool.IdMappingPolicy.Relationship
A relationship to the 'pool.IdMappingPolicy' resource, or the expanded 'pool.IdMappingPolicy' resource, or the 'null' value.
pool.IdMappingPolicy
A policy to define a grouping of deployment targets (resource groups and organizations) which can be mapped to ID blocks.
pool.IdMappingPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
pool.Reservation
Reservation object holding reserved identity information.
pool.ReservationReference
A reference to reservation object that needs to be used while allocating an identity.
recovery.AbstractBackupConfig
Base Backup configuration for local or remote server.
recovery.AbstractBackupInfo.Relationship
A relationship to the 'recovery.AbstractBackupInfo' resource, or the expanded 'recovery.AbstractBackupInfo' resource, or the 'null' value.
recovery.AbstractBackupInfo
Abstract class for backup objects of all devices.
recovery.BackupConfigPolicy.Response
The response body of a HTTP GET request for the 'recovery.BackupConfigPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified…
recovery.BackupConfigPolicy.Relationship
A relationship to the 'recovery.BackupConfigPolicy' resource, or the expanded 'recovery.BackupConfigPolicy' resource, or the 'null' value.
recovery.BackupConfigPolicy
The BackupConfigPolicy object defines comprehensive backup policies for local or remote servers. This provides the necessary inputs and configurations to execu…
recovery.BackupConfigPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
recovery.BackupProfile.Response
The response body of a HTTP GET request for the 'recovery.BackupProfile' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
recovery.BackupProfile.Relationship
A relationship to the 'recovery.BackupProfile' resource, or the expanded 'recovery.BackupProfile' resource, or the 'null' value.
recovery.BackupProfile
The BackupProfile object serves as the cornerstone for managing backup configurations on endpoints. It defines the parameters and conditions under which backup…
recovery.BackupProfile.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
recovery.BackupSchedule
Backup settings for user defined scheduling on endpoint.
recovery.ConfigParams
Restore workflows configuration parameters.
recovery.ConfigResult.Response
The response body of a HTTP GET request for the 'recovery.ConfigResult' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
recovery.ConfigResult.Relationship
A relationship to the 'recovery.ConfigResult' resource, or the expanded 'recovery.ConfigResult' resource, or the 'null' value.
recovery.ConfigResult
Profile configuration (deploy, validation) results with overall state and detailed message.
recovery.ConfigResult.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
recovery.ConfigResultEntry.Response
The response body of a HTTP GET request for the 'recovery.ConfigResultEntry' resource. The value may be one of the following types. 1. When 'tag' is specified…
recovery.ConfigResultEntry.Relationship
A relationship to the 'recovery.ConfigResultEntry' resource, or the expanded 'recovery.ConfigResultEntry' resource, or the 'null' value.
recovery.ConfigResultEntry
Backup profile state result entry on end device.
recovery.ConfigResultEntry.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
recovery.OnDemandBackup.Response
The response body of a HTTP GET request for the 'recovery.OnDemandBackup' resource. The value may be one of the following types. 1. When 'tag' is specified in…
recovery.OnDemandBackup
The OnDemandBackup object is tailored for initiating and managing immediate backup operations on endpoints. It caters to scenarios requiring quick and responsi…
recovery.OnDemandBackup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
recovery.Restore.Response
The response body of a HTTP GET request for the 'recovery.Restore' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
recovery.Restore
The Restore object is a critical component of the backup and restoration framework, focusing on the execution and management of restore operations on various i…
recovery.Restore.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
recovery.ScheduleConfigPolicy.Response
The response body of a HTTP GET request for the 'recovery.ScheduleConfigPolicy' resource. The value may be one of the following types. 1. When 'tag' is specifi…
recovery.ScheduleConfigPolicy.Relationship
A relationship to the 'recovery.ScheduleConfigPolicy' resource, or the expanded 'recovery.ScheduleConfigPolicy' resource, or the 'null' value.
recovery.ScheduleConfigPolicy
The ScheduleConfigPolicy object is integral to defining and managing scheduled backup operations on both local and remote servers. It establishes the parameter…
recovery.ScheduleConfigPolicy.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…
resourcepool.ChassisQualificationPolicy.Response
The response body of a HTTP GET request for the 'resourcepool.ChassisQualificationPolicy' resource. The value may be one of the following types. 1. When 'tag'…
resourcepool.ChassisQualificationPolicy
The ChassisQualificationPolicy maintains the qualifiers, and each qualifier manages a set of conditions to qualify the chassis and servers that connected to it…
resourcepool.ChassisQualificationPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.ChildLeaseCondition
Condition to determine the eligibility of the resource for leasing. The condition includes one or more qualifiers that define the resource's qualification for…
resourcepool.Lease.Response
The response body of a HTTP GET request for the 'resourcepool.Lease' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
resourcepool.Lease.Relationship
A relationship to the 'resourcepool.Lease' resource, or the expanded 'resourcepool.Lease' resource, or the 'null' value.
resourcepool.Lease
Lease API invoked by passing resource pool, lease API will reserve or un-reserve the resource from the pool.
resourcepool.Lease.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.LeaseParameters
The lease operations has some special operations based on the PoolType and ResourceType. Those special operations are handled based on this parameter.
resourcepool.LeaseResource.Response
The response body of a HTTP GET request for the 'resourcepool.LeaseResource' resource. The value may be one of the following types. 1. When 'tag' is specified…
resourcepool.LeaseResource.Relationship
A relationship to the 'resourcepool.LeaseResource' resource, or the expanded 'resourcepool.LeaseResource' resource, or the 'null' value.
resourcepool.LeaseResource
Lease API is for reserve or unreserve the resource from the pool. Those reserved resource details are maintained in LeaseResource.
resourcepool.LeaseResource.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.MembershipReservation.Response
The response body of a HTTP GET request for the 'resourcepool.MembershipReservation' resource. The value may be one of the following types. 1. When 'tag' is sp…
resourcepool.MembershipReservation
A MembershipReservation is created when a resource that belongs to a pool is decommissioned. The MembershipReservation is mapped to pools that have the resourc…
resourcepool.MembershipReservation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.Pool.Response
The response body of a HTTP GET request for the 'resourcepool.Pool' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
resourcepool.Pool.Relationship
A relationship to the 'resourcepool.Pool' resource, or the expanded 'resourcepool.Pool' resource, or the 'null' value.
resourcepool.Pool
Pool represents a collection of resource. The resource can be any MO which has PoolResource meta enabled. The resource in the pool can be reserved or unreserve…
resourcepool.Pool.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.PoolMember.Response
The response body of a HTTP GET request for the 'resourcepool.PoolMember' resource. The value may be one of the following types. 1. When 'tag' is specified in…
resourcepool.PoolMember.Relationship
A relationship to the 'resourcepool.PoolMember' resource, or the expanded 'resourcepool.PoolMember' resource, or the 'null' value.
resourcepool.PoolMember
PoolMember represents a resources that is part of a pool.
resourcepool.PoolMember.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.QualificationPolicy.Response
The response body of a HTTP GET request for the 'resourcepool.QualificationPolicy' resource. The value may be one of the following types. 1. When 'tag' is spec…
resourcepool.QualificationPolicy
The QualificationPolicy object is pivotal in managing conditions that qualify server resources within a pool. It is attached to pools to dynamically extract re…
resourcepool.QualificationPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.QualificationType
The QualificationType denotes the method by which a resource is added to a pool. It serves as an identifier to distinguish between static and dynamic resource…
resourcepool.Reservation.Response
The response body of a HTTP GET request for the 'resourcepool.Reservation' resource. The value may be one of the following types. 1. When 'tag' is specified in…
resourcepool.Reservation.Relationship
A relationship to the 'resourcepool.Reservation' resource, or the expanded 'resourcepool.Reservation' resource, or the 'null' value.
resourcepool.Reservation
The resource reservation object, used to hold reserved resources for a pool. It captures the reservation identity (for example, a serial), allocation type, and…
resourcepool.Reservation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resourcepool.ReservationReference
The reference to the reservation object.
resourcepool.ResourceEvaluationStatus
The resources are added to the pool based on conditions specified by the qualifiers. If there are any changes in the qualifier conditions or the properties of…
resourcepool.ResourcePoolParameters
The resource pool can hold different type of resources, each resources can have some specific parameters and functionality, those details are captured as part…
resourcepool.ServerLeaseParameters
This lease specific parameters are captured as part this parameter.
resourcepool.ServerPoolParameters
This server pool specific parameters are captured as part this parameter.
resourcepool.Universe.Response
The response body of a HTTP GET request for the 'resourcepool.Universe' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
resourcepool.Universe.Relationship
A relationship to the 'resourcepool.Universe' resource, or the expanded 'resourcepool.Universe' resource, or the 'null' value.
resourcepool.Universe
Universe represents a book keeping container to keep track of all Resources for a given Account.
resourcepool.Universe.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
rproxy.ReverseProxy
The ReverseProxy object serves as a pivotal element within the network infrastructure, enabling the implementation of REST API endpoints for reverse proxy oper…
scheduler.AbstractSchedulingParams
Set schedule parameters abstract type.
scheduler.AbstractTaskRequest
An abstract task request that can be extended to other types of task requests.
scheduler.BaseCadenceParams
The parameters for a onetime or recurring schedule.
scheduler.BaseMonthlyCadenceParams
The monthly cadence applied to monthly schedules.
scheduler.BaseScheduleParams
Defines the base class for setting up schedule parameters.
scheduler.BlockDate
It represents a range of calendar dates during which scheduling functionality is restricted. This is commonly used to not disrupt operations or schedule update…
scheduler.DailyCadenceParams
Parameters used for running daily (almost).
scheduler.EveryCadenceParams
Specify a cadence as every time.ParseDuration format string.
scheduler.MonthlyCadenceParams
Used for a monthly cadence.
scheduler.OneTimeScheduleParams
The parameters for configuring a onetime schedule.
scheduler.RecurringScheduleParams
The parameters for configuring a recurring schedule.
scheduler.RestStimTaskRequest
The parameters for a reststim invoked by the scheduler.
scheduler.SchedulePolicy.Response
The response body of a HTTP GET request for the 'scheduler.SchedulePolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in…
scheduler.SchedulePolicy.Relationship
A relationship to the 'scheduler.SchedulePolicy' resource, or the expanded 'scheduler.SchedulePolicy' resource, or the 'null' value.
scheduler.SchedulePolicy
SchedulePolicies define reusable, policy-based scheduling definitions for running tasks either one-time or on a recurring cadence. They encapsulate one or more…
scheduler.SchedulePolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
scheduler.TaskResult.Response
The response body of a HTTP GET request for the 'scheduler.TaskResult' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
scheduler.TaskResult
TaskResults represent individual execution instances produced by a TaskSchedule. For recurring schedules, each run yields a TaskResult record; for one-time sch…
scheduler.TaskResult.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
scheduler.TaskResultStatus
The status of a single instance of the scheduled task.
scheduler.TaskSchedule.Response
The response body of a HTTP GET request for the 'scheduler.TaskSchedule' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
scheduler.TaskSchedule.Relationship
A relationship to the 'scheduler.TaskSchedule' resource, or the expanded 'scheduler.TaskSchedule' resource, or the 'null' value.
scheduler.TaskSchedule
TaskSchedules are the runtime scheduling objects that drive one-time or recurring executions. A TaskSchedule can run directly using explicit schedule parameter…
scheduler.TaskSchedule.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
scheduler.TaskSchedulePolicyExecutionStatus
The scheduled Task execution status per schedule defined in SchedulePolicy.
scheduler.TaskScheduleStatus
The scheduled task details.
scheduler.WeeklyCadenceParams
Parameters used for weekly cadence.
sdaaci.Connection.Response
The response body of a HTTP GET request for the 'sdaaci.Connection' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
sdaaci.Connection.Relationship
A relationship to the 'sdaaci.Connection' resource, or the expanded 'sdaaci.Connection' resource, or the 'null' value.
sdaaci.Connection
The Connection object is an integral part of the network management system, designed to facilitate the establishment and management of direct connections betwe…
sdaaci.Connection.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
sdaaci.ConnectionDetail.Response
The response body of a HTTP GET request for the 'sdaaci.ConnectionDetail' resource. The value may be one of the following types. 1. When 'tag' is specified in…
sdaaci.ConnectionDetail
Peer connection details for all connections.
sdaaci.ConnectionDetail.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
search.SearchItem.Response
The response body of a HTTP GET request for the 'search.SearchItem' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
search.SearchItem
The SearchItem object represents an entry point for searching Intersight REST resources. It enables users to query and retrieve data using the OData query synt…
search.SearchItem.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
search.TagItem.Response
The response body of a HTTP GET request for the 'search.TagItem' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
search.TagItem
The TagItem object serves as an entry point for searching tags associated with Intersight REST resources. It allows users to query and discover tags across the…
search.TagItem.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
serviceitem.BaseMessage
BaseMessage holds the common set of properties that are logged across CatalogServiceRequest, and ServiceItemActionInstance. The messages can be of different se…
serviceitem.HealthCheckErrorElement
Details about the service item elements of particular type (eg. Server, Storage, etc.) for which the health check has failed.
serviceitem.Message
The instance status message can be used at ServiceItemInstance and ServiceItemActionInstance level.
serviceitem.SelectionCriteriaInput
The policy based input is available at service item action definition and catalog item which is evaluated at runtime, SelectionCriteriaInput is used to capture…
servicerequest.Message
The instance status message can be used at CatalogServiceRequest level.
session.AbstractSession.Relationship
A relationship to the 'session.AbstractSession' resource, or the expanded 'session.AbstractSession' resource, or the 'null' value.
session.AbstractSession
A base abstract class for all sessions.
session.AbstractSubSession
A base abstract class for all sub-sessions.
software.ApplianceDistributable.Response
The response body of a HTTP GET request for the 'software.ApplianceDistributable' resource. The value may be one of the following types. 1. When 'tag' is speci…
software.ApplianceDistributable
The ApplianceDistributable object represents an appliance image distributed by Cisco. It is designed for upgrading on-premise Intersight Appliances, supporting…
software.ApplianceDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.DownloadHistory.Response
The response body of a HTTP GET request for the 'software.DownloadHistory' resource. The value may be one of the following types. 1. When 'tag' is specified in…
software.DownloadHistory
An object to keep track of software downloads from the Private Appliance portal in SaaS.
software.DownloadHistory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.HciBundleDistributable.Response
The response body of a HTTP GET request for the 'software.HciBundleDistributable' resource. The value may be one of the following types. 1. When 'tag' is speci…
software.HciBundleDistributable
An HCI image bundle distributed by Cisco for Private Appliance.
software.HciBundleDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.HciDistributable.Response
The response body of a HTTP GET request for the 'software.HciDistributable' resource. The value may be one of the following types. 1. When 'tag' is specified i…
software.HciDistributable.Relationship
A relationship to the 'software.HciDistributable' resource, or the expanded 'software.HciDistributable' resource, or the 'null' value.
software.HciDistributable
An HCI image distributed by Cisco.
software.HciDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.HclMeta.Response
The response body of a HTTP GET request for the 'software.HclMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
software.HclMeta
A JSON file wth HCL metadata uploaded for consumption by the HCL service.
software.HclMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.HyperflexBundleDistributable.Response
The response body of a HTTP GET request for the 'software.HyperflexBundleDistributable' resource. The value may be one of the following types. 1. When 'tag' is…
software.HyperflexBundleDistributable
A HyperFlex image bundle distributed by Cisco for Private Appliance.
software.HyperflexBundleDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.HyperflexDistributable.Response
The response body of a HTTP GET request for the 'software.HyperflexDistributable' resource. The value may be one of the following types. 1. When 'tag' is speci…
software.HyperflexDistributable.Relationship
A relationship to the 'software.HyperflexDistributable' resource, or the expanded 'software.HyperflexDistributable' resource, or the 'null' value.
software.HyperflexDistributable
A HyperFlex image distributed by Cisco.
software.HyperflexDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.IksBundleDistributable.Response
The response body of a HTTP GET request for the 'software.IksBundleDistributable' resource. The value may be one of the following types. 1. When 'tag' is speci…
software.IksBundleDistributable
An IKS image bundle distributed by Cisco for Private Appliance.
software.IksBundleDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.ReleaseMeta.Response
The response body of a HTTP GET request for the 'software.ReleaseMeta' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
software.ReleaseMeta
Release information for various software images. Gives information on the latest released version of a product.
software.ReleaseMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.SolutionDistributable.Response
The response body of a HTTP GET request for the 'software.SolutionDistributable' resource. The value may be one of the following types. 1. When 'tag' is specif…
software.SolutionDistributable.Relationship
A relationship to the 'software.SolutionDistributable' resource, or the expanded 'software.SolutionDistributable' resource, or the 'null' value.
software.SolutionDistributable
The SolutionDistributable object represents a solution image distributed by Cisco. It is a key component in deploying and upgrading solution-specific images wi…
software.SolutionDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.UcsdBundleDistributable.Response
The response body of a HTTP GET request for the 'software.UcsdBundleDistributable' resource. The value may be one of the following types. 1. When 'tag' is spec…
software.UcsdBundleDistributable
A UCSD connector pack image bundle distributed by Cisco for Private Appliance.
software.UcsdBundleDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
software.UcsdDistributable.Response
The response body of a HTTP GET request for the 'software.UcsdDistributable' resource. The value may be one of the following types. 1. When 'tag' is specified…
software.UcsdDistributable.Relationship
A relationship to the 'software.UcsdDistributable' resource, or the expanded 'software.UcsdDistributable' resource, or the 'null' value.
software.UcsdDistributable
A UCSD connector pack image distributed by Cisco.
software.UcsdDistributable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.ApplianceUpload
The user's local machine is being used as the source of an image. This upload operation is for an airgapped appliance.
softwarerepository.Authorization.Response
The response body of a HTTP GET request for the 'softwarerepository.Authorization' resource. The value may be one of the following types. 1. When 'tag' is spec…
softwarerepository.Authorization
User's consent for Intersight to contact an external software repository such as cisco.com, on the behalf of the user.
softwarerepository.Authorization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.BaseDistributable
An image distributed by Cisco.
softwarerepository.CachedImage.Response
The response body of a HTTP GET request for the 'softwarerepository.CachedImage' resource. The value may be one of the following types. 1. When 'tag' is specif…
softwarerepository.CachedImage
The image cached in the customer's datacenter.
softwarerepository.CachedImage.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.Catalog.Response
The response body of a HTTP GET request for the 'softwarerepository.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified…
softwarerepository.Catalog.Relationship
A relationship to the 'softwarerepository.Catalog' resource, or the expanded 'softwarerepository.Catalog' resource, or the 'null' value.
softwarerepository.Catalog
A container MO that holds references to the files in an account's image repository. It is internally created for each account and is used to hold information a…
softwarerepository.Catalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.CategoryMapper.Response
The response body of a HTTP GET request for the 'softwarerepository.CategoryMapper' resource. The value may be one of the following types. 1. When 'tag' is spe…
softwarerepository.CategoryMapper
The CategoryMapper object serves as a mapping tool to associate Cisco software repository image categories with applicable hardware models. This ensures compat…
softwarerepository.CategoryMapper.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.CategoryMapperModel.Response
The response body of a HTTP GET request for the 'softwarerepository.CategoryMapperModel' resource. The value may be one of the following types. 1. When 'tag' i…
softwarerepository.CategoryMapperModel
The CategoryMapperModel object maps Cisco hardware model series to their applicable hardware models. It is a critical component in defining hardware compatibil…
softwarerepository.CategoryMapperModel.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.CategorySupportConstraint.Response
The response body of a HTTP GET request for the 'softwarerepository.CategorySupportConstraint' resource. The value may be one of the following types. 1. When '…
softwarerepository.CategorySupportConstraint
The CategorySupportConstraint object defines constraints for models supported from certain minimum image versions. It plays a vital role in managing software c…
softwarerepository.CategorySupportConstraint.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.CategoryUnsupportedModels.Response
The response body of a HTTP GET request for the 'softwarerepository.CategoryUnsupportedModels' resource. The value may be one of the following types. 1. When '…
softwarerepository.CategoryUnsupportedModels
The CategoryUnsupportedModels object defines constraints for models that become unsupported after specific infra versions. It is crucial for managing software…
softwarerepository.CategoryUnsupportedModels.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.CifsServer
An external file repository accessible through the CIFS protocol.
softwarerepository.ConstraintModels
It defines a contraint that given an image name regex and version, only certain models are supported for firmware upgrades.
softwarerepository.DownloadSpec.Response
The response body of a HTTP GET request for the 'softwarerepository.DownloadSpec' resource. The value may be one of the following types. 1. When 'tag' is speci…
softwarerepository.DownloadSpec
The URL, certificate and other associated information required to download an image listed in an Intersight catalog.
softwarerepository.DownloadSpec.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.File.Relationship
A relationship to the 'softwarerepository.File' resource, or the expanded 'softwarerepository.File' resource, or the 'null' value.
softwarerepository.File
A file that resides either in an external repository or has been imported to the local repository. If the file is available in the local repository, it is mark…
softwarerepository.FileServer
An external software repository which serves as the source of the file to be imported into the image catalog. If the source is available in the user's local ma…
softwarerepository.HttpServer
An external HTTP file server. This can represent the cisco.com website or a HTTP server in the user's datacenter.
softwarerepository.ImportResult
The status of the import operation.
softwarerepository.LocalMachine
The user's local machine that is being used as the source for an image.
softwarerepository.NfsServer
An external file repository accessible through the NFS protocol.
softwarerepository.OperatingSystemFile.Response
The response body of a HTTP GET request for the 'softwarerepository.OperatingSystemFile' resource. The value may be one of the following types. 1. When 'tag' i…
softwarerepository.OperatingSystemFile.Relationship
A relationship to the 'softwarerepository.OperatingSystemFile' resource, or the expanded 'softwarerepository.OperatingSystemFile' resource, or the 'null' value.
softwarerepository.OperatingSystemFile
The OperatingSystemFile object represents an operating system image that can reside in an external repository or be imported to a local repository. It supports…
softwarerepository.OperatingSystemFile.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.Release.Response
The response body of a HTTP GET request for the 'softwarerepository.Release' resource. The value may be one of the following types. 1. When 'tag' is specified…
softwarerepository.Release.Relationship
A relationship to the 'softwarerepository.Release' resource, or the expanded 'softwarerepository.Release' resource, or the 'null' value.
softwarerepository.Release
A Cisco release containing one or more firmware images. Cisco releases images for rack server components or blade server components or for Fabric Interconnect…
softwarerepository.Release.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
softwarerepository.UnsupportedModelConstraint
It defines a constraint that given an image name and version, server models are unsupported for firmware upgrades.
sw.IdPoolBase
Container representation of the Idpools defined for fabric.
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.
techsupportmanagement.ApplianceParam
Appliance parameter object for Tech Support requests.
techsupportmanagement.CollectionControlPolicy.Response
The response body of a HTTP GET request for the 'techsupportmanagement.CollectionControlPolicy' resource. The value may be one of the following types. 1. When…
techsupportmanagement.CollectionControlPolicy
Policy to control techsupport collection for a specific account.
techsupportmanagement.CollectionControlPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
techsupportmanagement.Download.Response
The response body of a HTTP GET request for the 'techsupportmanagement.Download' resource. The value may be one of the following types. 1. When 'tag' is specif…
techsupportmanagement.Download
Download the techsupport file. The response to this API will be the actual techsupport file. This API needs to be invoked using the download link obtained by d…
techsupportmanagement.Download.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
techsupportmanagement.EndPoint.Response
The response body of a HTTP GET request for the 'techsupportmanagement.EndPoint' resource. The value may be one of the following types. 1. When 'tag' is specif…
techsupportmanagement.EndPoint
An endpoint that has registered for techsupport collection service on Intersight. Intersight services must create an Endpoint MO for every endpoint (hardware d…
techsupportmanagement.EndPoint.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
techsupportmanagement.NiaParam
NIA parameter object for Tech Support requests.
techsupportmanagement.PlatformParam
Parameter object for techsupport request that can be used to specify techsupport collection pararmeters.
techsupportmanagement.TechSupportBundle.Response
The response body of a HTTP GET request for the 'techsupportmanagement.TechSupportBundle' resource. The value may be one of the following types. 1. When 'tag'…
techsupportmanagement.TechSupportBundle.Relationship
A relationship to the 'techsupportmanagement.TechSupportBundle' resource, or the expanded 'techsupportmanagement.TechSupportBundle' resource, or the 'null' val…
techsupportmanagement.TechSupportBundle
A request to collect techsupport and upload it to Intersight Storage Service. The serial number, PID and/or relationship to the target resource provided by the…
techsupportmanagement.TechSupportBundle.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
techsupportmanagement.TechSupportFileInfo
TechSupportFileInfo contains information regarding a single techsupport file produced by a techsupport collection that produces multiple files. A user can trac…
techsupportmanagement.TechSupportStatus.Response
The response body of a HTTP GET request for the 'techsupportmanagement.TechSupportStatus' resource. The value may be one of the following types. 1. When 'tag'…
techsupportmanagement.TechSupportStatus.Relationship
A relationship to the 'techsupportmanagement.TechSupportStatus' resource, or the expanded 'techsupportmanagement.TechSupportStatus' resource, or the 'null' val…
techsupportmanagement.TechSupportStatus
The techsupport collection status.
techsupportmanagement.TechSupportStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
template.TransformationStage
In Intersight workflows, task inputs may require data in a specific format. When the available value does not match the expected form, it must be transformed b…
top.System.Response
The response body of a HTTP GET request for the 'top.System' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
top.System.Relationship
A relationship to the 'top.System' resource, or the expanded 'top.System' resource, or the 'null' value.
top.System
Root container for all UCSM / CIMC MOs.
top.System.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
tunneling.Tunnel
The tunnel that exists between the client and the DC.
ucsdconnector.RestClientMessage
RestClient Message type which would constitute of the following types.
view.HealthStatus.Response
The response body of a HTTP GET request for the 'view.HealthStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
view.HealthStatus
The HealthStatus object is designed to provide a high-level, aggregated status of Intersight components for a given account user. It informs users about potent…
view.HealthStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
view.Server.Response
The response body of a HTTP GET request for the 'view.Server' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
view.Server
The Server object facilitates querying a list of UCS servers, including API resource types compute.Blade and compute.RackUnit, along with associated managed ob…
view.Server.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.AssignedResource
Resource that has been assigned to a workload instance.
workload.BaseBlueprintReference
Base type to capture all details about the referenced blueprint. This base type will be used to capture referenced blueprint details within Workload and Deploy…
workload.BatchDeployment
The number of instances to be included in each batch during the deployment..
workload.Blueprint.Response
The response body of a HTTP GET request for the 'workload.Blueprint' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
workload.Blueprint
Overview The Blueprint object defines a reusable, versioned template for deploying infrastructure configurations and services. It encapsulates input schemas, m…
workload.Blueprint.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.BlueprintInputReference
Type to capture the input data for the referred blueprint.
workload.BlueprintReference
Type to capture all details about the blueprint referenced within this workload.
workload.CanaryDeployment
The percentage of instances to which the changes will be rolled out in each step of the deployment.
workload.ClearWorkloadTag.Response
The response body of a HTTP GET request for the 'workload.ClearWorkloadTag' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workload.ClearWorkloadTag
Overview The ClearWorkloadTag API helps remove the system-defined workload tag from the specified objects. This API should only be used under the guidance of T…
workload.ClearWorkloadTag.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.CloneStatus
The status of the clone operation for workload blueprint inputs, used to track the progress of cloning a workload definition input.
workload.CloneStatusEntry
The status of the clone operation for a workload blueprint input. It is used to track the progress of cloning a workload definition.
workload.DefinitionMapper
Captures the definition and its version to map values for consumers. For example, a WorkloadDeployment references a WorkloadDefinition, containing both the Wor…
workload.DeploymentBlueprintInputType
Type to capture the input data for the referred blueprint.
workload.DeploymentChangeDetail
Captures details of changes at the workload deployment level.
workload.DeploymentInput.Response
The response body of a HTTP GET request for the 'workload.DeploymentInput' resource. The value may be one of the following types. 1. When 'tag' is specified in…
workload.DeploymentInput.Relationship
A relationship to the 'workload.DeploymentInput' resource, or the expanded 'workload.DeploymentInput' resource, or the 'null' value.
workload.DeploymentInput
Overview The DeploymentInput object captures a versioned snapshot of all input parameters and configuration values for a workload deployment at a specific poin…
workload.DeploymentInput.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.GeneratedObject
A generated object that is created as part of the workload deployment when creating prerequisite objects for service item deployment. The generated object is c…
workload.RenameRequest
The request for a rename operation on an object.
workload.ResourceConstraint
The constraints that need to be applied to the resources in order to match this blueprint.
workload.RolloutStrategy
Defines the strategy for rolling out changes to instances.
workload.StateAggregation
The aggregated state information for a collection of referenced objects, including their overall state and count.
workload.WorkloadDefinition.Response
The response body of a HTTP GET request for the 'workload.WorkloadDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified…
workload.WorkloadDefinition.Relationship
A relationship to the 'workload.WorkloadDefinition' resource, or the expanded 'workload.WorkloadDefinition' resource, or the 'null' value.
workload.WorkloadDefinition
Overview The WorkloadDefinition object represents the blueprint for defining reusable workload configurations that can be deployed across one or more organizat…
workload.WorkloadDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.WorkloadDeployment.Response
The response body of a HTTP GET request for the 'workload.WorkloadDeployment' resource. The value may be one of the following types. 1. When 'tag' is specified…
workload.WorkloadDeployment.Relationship
A relationship to the 'workload.WorkloadDeployment' resource, or the expanded 'workload.WorkloadDeployment' resource, or the 'null' value.
workload.WorkloadDeployment
Overview The WorkloadDeployment object represents an active deployment configuration that creates and manages workload instances based on a workload definition…
workload.WorkloadDeployment.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.WorkloadInstance.Response
The response body of a HTTP GET request for the 'workload.WorkloadInstance' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workload.WorkloadInstance
Overview The WorkloadInstance object represents a single deployed instance of a workload, created and managed by a workload deployment. It captures the runtime…
workload.WorkloadInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.WorkloadMetadata.Response
The response body of a HTTP GET request for the 'workload.WorkloadMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workload.WorkloadMetadata.Relationship
A relationship to the 'workload.WorkloadMetadata' resource, or the expanded 'workload.WorkloadMetadata' resource, or the 'null' value.
workload.WorkloadMetadata
Overview The WorkloadMetadata holds version agnostic information about a workload definition. It serves as a statistical summary and aggregation container for…
workload.WorkloadMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
x509.Certificate
The representation of an X.509 certificate.
DisplayNames
object
A set of display names for the MO resource. These names are calculated based on other properties of the MO and potentially properties of Ancestor MOs. Displayn…
mo.BaseResponse
object
The base response schema.
1 property
1 required
mo.AggregateTransform
The output of a request that includes the $apply query parameter. The schema of an aggregation query is dynamically determined based on the request query param…
mo.DocumentCount
A document returned in a response body when the HTTP GET request specifies the '$count' query parameter.
mo.TagKeySummary
object
A summary of the Tag usage for an API resource. Tags are Key, Value pairs that can be assigned to API resources.
3 properties
mo.TagSummary
A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.
PatchDocument
object
A JSONPatch document as defined by RFC 6902. A JSONPatch document can be used in a request body when the 'Content-Type' HTTP header is set to 'application/json…
4 properties
2 required
Error
object
4 properties
2 required
CsvFile
string
The content is a comma-separated list of values.
ExcelFile
string
The content is an Excel spreadsheet.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Intersight publishes across the network.