Skip to content

Latest commit

 

History

History
1471 lines (1077 loc) · 99.3 KB

File metadata and controls

1471 lines (1077 loc) · 99.3 KB

IntersightClient::ChassisApi

All URIs are relative to https://intersight.com

Method HTTP request Description
create_chassis_config_import POST /api/v1/chassis/ConfigImports Create a 'chassis.ConfigImport' resource.
create_chassis_profile POST /api/v1/chassis/Profiles Create a 'chassis.Profile' resource.
delete_chassis_profile DELETE /api/v1/chassis/Profiles/{Moid} Delete a 'chassis.Profile' resource.
get_chassis_config_change_detail_by_moid GET /api/v1/chassis/ConfigChangeDetails/{Moid} Read a 'chassis.ConfigChangeDetail' resource.
get_chassis_config_change_detail_list GET /api/v1/chassis/ConfigChangeDetails Read a 'chassis.ConfigChangeDetail' resource.
get_chassis_config_import_by_moid GET /api/v1/chassis/ConfigImports/{Moid} Read a 'chassis.ConfigImport' resource.
get_chassis_config_import_list GET /api/v1/chassis/ConfigImports Read a 'chassis.ConfigImport' resource.
get_chassis_config_result_by_moid GET /api/v1/chassis/ConfigResults/{Moid} Read a 'chassis.ConfigResult' resource.
get_chassis_config_result_entry_by_moid GET /api/v1/chassis/ConfigResultEntries/{Moid} Read a 'chassis.ConfigResultEntry' resource.
get_chassis_config_result_entry_list GET /api/v1/chassis/ConfigResultEntries Read a 'chassis.ConfigResultEntry' resource.
get_chassis_config_result_list GET /api/v1/chassis/ConfigResults Read a 'chassis.ConfigResult' resource.
get_chassis_iom_profile_by_moid GET /api/v1/chassis/IomProfiles/{Moid} Read a 'chassis.IomProfile' resource.
get_chassis_iom_profile_list GET /api/v1/chassis/IomProfiles Read a 'chassis.IomProfile' resource.
get_chassis_profile_by_moid GET /api/v1/chassis/Profiles/{Moid} Read a 'chassis.Profile' resource.
get_chassis_profile_list GET /api/v1/chassis/Profiles Read a 'chassis.Profile' resource.
patch_chassis_profile PATCH /api/v1/chassis/Profiles/{Moid} Update a 'chassis.Profile' resource.
update_chassis_profile POST /api/v1/chassis/Profiles/{Moid} Update a 'chassis.Profile' resource.

create_chassis_config_import

create_chassis_config_import(chassis_config_import, opts)

Create a 'chassis.ConfigImport' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
chassis_config_import = IntersightClient::ChassisConfigImport.new({class_id: 'chassis.ConfigImport', object_type: 'chassis.ConfigImport'}) # ChassisConfigImport | The 'chassis.ConfigImport' resource to create.
opts = {
  if_match: 'if_match_example', # String | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.
  if_none_match: 'if_none_match_example' # String | For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn't happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don't have to be identical byte for byte.
}

begin
  # Create a 'chassis.ConfigImport' resource.
  result = api_instance.create_chassis_config_import(chassis_config_import, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->create_chassis_config_import: #{e}"
end

Using the create_chassis_config_import_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_chassis_config_import_with_http_info(chassis_config_import, opts)

begin
  # Create a 'chassis.ConfigImport' resource.
  data, status_code, headers = api_instance.create_chassis_config_import_with_http_info(chassis_config_import, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigImport>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->create_chassis_config_import_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
chassis_config_import ChassisConfigImport The 'chassis.ConfigImport' resource to create.
if_match String For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. [optional]
if_none_match String For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn't happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don't have to be identical byte for byte. [optional]

Return type

ChassisConfigImport

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_chassis_profile

create_chassis_profile(chassis_profile, opts)

Create a 'chassis.Profile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
chassis_profile = IntersightClient::ChassisProfile.new({class_id: 'chassis.Profile', object_type: 'chassis.Profile'}) # ChassisProfile | The 'chassis.Profile' resource to create.
opts = {
  if_match: 'if_match_example', # String | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.
  if_none_match: 'if_none_match_example' # String | For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn't happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don't have to be identical byte for byte.
}

begin
  # Create a 'chassis.Profile' resource.
  result = api_instance.create_chassis_profile(chassis_profile, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->create_chassis_profile: #{e}"
end

Using the create_chassis_profile_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_chassis_profile_with_http_info(chassis_profile, opts)

begin
  # Create a 'chassis.Profile' resource.
  data, status_code, headers = api_instance.create_chassis_profile_with_http_info(chassis_profile, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisProfile>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->create_chassis_profile_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
chassis_profile ChassisProfile The 'chassis.Profile' resource to create.
if_match String For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. [optional]
if_none_match String For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn't happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don't have to be identical byte for byte. [optional]

Return type

ChassisProfile

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_chassis_profile

delete_chassis_profile(moid)

Delete a 'chassis.Profile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Delete a 'chassis.Profile' resource.
  api_instance.delete_chassis_profile(moid)
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->delete_chassis_profile: #{e}"
end

Using the delete_chassis_profile_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_chassis_profile_with_http_info(moid)

begin
  # Delete a 'chassis.Profile' resource.
  data, status_code, headers = api_instance.delete_chassis_profile_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->delete_chassis_profile_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.

Return type

nil (empty response body)

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_chassis_config_change_detail_by_moid

get_chassis_config_change_detail_by_moid(moid)

Read a 'chassis.ConfigChangeDetail' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'chassis.ConfigChangeDetail' resource.
  result = api_instance.get_chassis_config_change_detail_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_change_detail_by_moid: #{e}"
end

Using the get_chassis_config_change_detail_by_moid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_change_detail_by_moid_with_http_info(moid)

begin
  # Read a 'chassis.ConfigChangeDetail' resource.
  data, status_code, headers = api_instance.get_chassis_config_change_detail_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigChangeDetail>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_change_detail_by_moid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.

Return type

ChassisConfigChangeDetail

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_config_change_detail_list

get_chassis_config_change_detail_list(opts)

Read a 'chassis.ConfigChangeDetail' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
opts = {
  filter: '$filter=CreateTime gt 2012-08-29T21:58:33Z', # String | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).
  orderby: '$orderby=CreationTime', # String | Determines what properties are used to sort the collection of resources.
  top: $top=10, # Integer | Specifies the maximum number of resources to return in the response.
  skip: $skip=100, # Integer | Specifies the number of resources to skip in the response.
  select: '$select=CreateTime,ModTime', # String | Specifies a subset of properties to return.
  expand: '$expand=DisplayNames', # String | Specify additional attributes or related resources to return in addition to the primary resources.
  apply: 'apply_example', # String | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.
  count: false, # Boolean | The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
  inlinecount: 'allpages', # String | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
  at: 'at=VersionType eq 'Configured'', # String | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.
  tags: 'tags_example' # String | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.
}

begin
  # Read a 'chassis.ConfigChangeDetail' resource.
  result = api_instance.get_chassis_config_change_detail_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_change_detail_list: #{e}"
end

Using the get_chassis_config_change_detail_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_change_detail_list_with_http_info(opts)

begin
  # Read a 'chassis.ConfigChangeDetail' resource.
  data, status_code, headers = api_instance.get_chassis_config_change_detail_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigChangeDetailResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_change_detail_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). [optional][default to '']
orderby String Determines what properties are used to sort the collection of resources. [optional]
top Integer Specifies the maximum number of resources to return in the response. [optional][default to 100]
skip Integer Specifies the number of resources to skip in the response. [optional][default to 0]
select String Specifies a subset of properties to return. [optional][default to '']
expand String Specify additional attributes or related resources to return in addition to the primary resources. [optional]
apply String Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. [optional]
count Boolean The $count query specifies the service should return the count of the matching resources, instead of returning the resources. [optional]
inlinecount String The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. [optional][default to 'allpages']
at String Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. [optional]
tags String The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. [optional]

Return type

ChassisConfigChangeDetailResponse

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_config_import_by_moid

get_chassis_config_import_by_moid(moid)

Read a 'chassis.ConfigImport' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'chassis.ConfigImport' resource.
  result = api_instance.get_chassis_config_import_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_import_by_moid: #{e}"
end

Using the get_chassis_config_import_by_moid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_import_by_moid_with_http_info(moid)

begin
  # Read a 'chassis.ConfigImport' resource.
  data, status_code, headers = api_instance.get_chassis_config_import_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigImport>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_import_by_moid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.

Return type

ChassisConfigImport

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_config_import_list

get_chassis_config_import_list(opts)

Read a 'chassis.ConfigImport' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
opts = {
  filter: '$filter=CreateTime gt 2012-08-29T21:58:33Z', # String | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).
  orderby: '$orderby=CreationTime', # String | Determines what properties are used to sort the collection of resources.
  top: $top=10, # Integer | Specifies the maximum number of resources to return in the response.
  skip: $skip=100, # Integer | Specifies the number of resources to skip in the response.
  select: '$select=CreateTime,ModTime', # String | Specifies a subset of properties to return.
  expand: '$expand=DisplayNames', # String | Specify additional attributes or related resources to return in addition to the primary resources.
  apply: 'apply_example', # String | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.
  count: false, # Boolean | The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
  inlinecount: 'allpages', # String | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
  at: 'at=VersionType eq 'Configured'', # String | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.
  tags: 'tags_example' # String | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.
}

begin
  # Read a 'chassis.ConfigImport' resource.
  result = api_instance.get_chassis_config_import_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_import_list: #{e}"
end

Using the get_chassis_config_import_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_import_list_with_http_info(opts)

begin
  # Read a 'chassis.ConfigImport' resource.
  data, status_code, headers = api_instance.get_chassis_config_import_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigImportResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_import_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). [optional][default to '']
orderby String Determines what properties are used to sort the collection of resources. [optional]
top Integer Specifies the maximum number of resources to return in the response. [optional][default to 100]
skip Integer Specifies the number of resources to skip in the response. [optional][default to 0]
select String Specifies a subset of properties to return. [optional][default to '']
expand String Specify additional attributes or related resources to return in addition to the primary resources. [optional]
apply String Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. [optional]
count Boolean The $count query specifies the service should return the count of the matching resources, instead of returning the resources. [optional]
inlinecount String The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. [optional][default to 'allpages']
at String Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. [optional]
tags String The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. [optional]

Return type

ChassisConfigImportResponse

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_config_result_by_moid

get_chassis_config_result_by_moid(moid)

Read a 'chassis.ConfigResult' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'chassis.ConfigResult' resource.
  result = api_instance.get_chassis_config_result_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_by_moid: #{e}"
end

Using the get_chassis_config_result_by_moid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_result_by_moid_with_http_info(moid)

begin
  # Read a 'chassis.ConfigResult' resource.
  data, status_code, headers = api_instance.get_chassis_config_result_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigResult>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_by_moid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.

Return type

ChassisConfigResult

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_config_result_entry_by_moid

get_chassis_config_result_entry_by_moid(moid)

Read a 'chassis.ConfigResultEntry' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'chassis.ConfigResultEntry' resource.
  result = api_instance.get_chassis_config_result_entry_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_entry_by_moid: #{e}"
end

Using the get_chassis_config_result_entry_by_moid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_result_entry_by_moid_with_http_info(moid)

begin
  # Read a 'chassis.ConfigResultEntry' resource.
  data, status_code, headers = api_instance.get_chassis_config_result_entry_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigResultEntry>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_entry_by_moid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.

Return type

ChassisConfigResultEntry

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_config_result_entry_list

get_chassis_config_result_entry_list(opts)

Read a 'chassis.ConfigResultEntry' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
opts = {
  filter: '$filter=CreateTime gt 2012-08-29T21:58:33Z', # String | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).
  orderby: '$orderby=CreationTime', # String | Determines what properties are used to sort the collection of resources.
  top: $top=10, # Integer | Specifies the maximum number of resources to return in the response.
  skip: $skip=100, # Integer | Specifies the number of resources to skip in the response.
  select: '$select=CreateTime,ModTime', # String | Specifies a subset of properties to return.
  expand: '$expand=DisplayNames', # String | Specify additional attributes or related resources to return in addition to the primary resources.
  apply: 'apply_example', # String | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.
  count: false, # Boolean | The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
  inlinecount: 'allpages', # String | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
  at: 'at=VersionType eq 'Configured'', # String | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.
  tags: 'tags_example' # String | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.
}

begin
  # Read a 'chassis.ConfigResultEntry' resource.
  result = api_instance.get_chassis_config_result_entry_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_entry_list: #{e}"
end

Using the get_chassis_config_result_entry_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_result_entry_list_with_http_info(opts)

begin
  # Read a 'chassis.ConfigResultEntry' resource.
  data, status_code, headers = api_instance.get_chassis_config_result_entry_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigResultEntryResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_entry_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). [optional][default to '']
orderby String Determines what properties are used to sort the collection of resources. [optional]
top Integer Specifies the maximum number of resources to return in the response. [optional][default to 100]
skip Integer Specifies the number of resources to skip in the response. [optional][default to 0]
select String Specifies a subset of properties to return. [optional][default to '']
expand String Specify additional attributes or related resources to return in addition to the primary resources. [optional]
apply String Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. [optional]
count Boolean The $count query specifies the service should return the count of the matching resources, instead of returning the resources. [optional]
inlinecount String The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. [optional][default to 'allpages']
at String Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. [optional]
tags String The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. [optional]

Return type

ChassisConfigResultEntryResponse

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_config_result_list

get_chassis_config_result_list(opts)

Read a 'chassis.ConfigResult' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
opts = {
  filter: '$filter=CreateTime gt 2012-08-29T21:58:33Z', # String | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).
  orderby: '$orderby=CreationTime', # String | Determines what properties are used to sort the collection of resources.
  top: $top=10, # Integer | Specifies the maximum number of resources to return in the response.
  skip: $skip=100, # Integer | Specifies the number of resources to skip in the response.
  select: '$select=CreateTime,ModTime', # String | Specifies a subset of properties to return.
  expand: '$expand=DisplayNames', # String | Specify additional attributes or related resources to return in addition to the primary resources.
  apply: 'apply_example', # String | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.
  count: false, # Boolean | The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
  inlinecount: 'allpages', # String | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
  at: 'at=VersionType eq 'Configured'', # String | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.
  tags: 'tags_example' # String | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.
}

begin
  # Read a 'chassis.ConfigResult' resource.
  result = api_instance.get_chassis_config_result_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_list: #{e}"
end

Using the get_chassis_config_result_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_config_result_list_with_http_info(opts)

begin
  # Read a 'chassis.ConfigResult' resource.
  data, status_code, headers = api_instance.get_chassis_config_result_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisConfigResultResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_config_result_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). [optional][default to '']
orderby String Determines what properties are used to sort the collection of resources. [optional]
top Integer Specifies the maximum number of resources to return in the response. [optional][default to 100]
skip Integer Specifies the number of resources to skip in the response. [optional][default to 0]
select String Specifies a subset of properties to return. [optional][default to '']
expand String Specify additional attributes or related resources to return in addition to the primary resources. [optional]
apply String Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. [optional]
count Boolean The $count query specifies the service should return the count of the matching resources, instead of returning the resources. [optional]
inlinecount String The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. [optional][default to 'allpages']
at String Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. [optional]
tags String The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. [optional]

Return type

ChassisConfigResultResponse

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_iom_profile_by_moid

get_chassis_iom_profile_by_moid(moid)

Read a 'chassis.IomProfile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'chassis.IomProfile' resource.
  result = api_instance.get_chassis_iom_profile_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_iom_profile_by_moid: #{e}"
end

Using the get_chassis_iom_profile_by_moid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_iom_profile_by_moid_with_http_info(moid)

begin
  # Read a 'chassis.IomProfile' resource.
  data, status_code, headers = api_instance.get_chassis_iom_profile_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisIomProfile>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_iom_profile_by_moid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.

Return type

ChassisIomProfile

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_iom_profile_list

get_chassis_iom_profile_list(opts)

Read a 'chassis.IomProfile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
opts = {
  filter: '$filter=CreateTime gt 2012-08-29T21:58:33Z', # String | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).
  orderby: '$orderby=CreationTime', # String | Determines what properties are used to sort the collection of resources.
  top: $top=10, # Integer | Specifies the maximum number of resources to return in the response.
  skip: $skip=100, # Integer | Specifies the number of resources to skip in the response.
  select: '$select=CreateTime,ModTime', # String | Specifies a subset of properties to return.
  expand: '$expand=DisplayNames', # String | Specify additional attributes or related resources to return in addition to the primary resources.
  apply: 'apply_example', # String | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.
  count: false, # Boolean | The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
  inlinecount: 'allpages', # String | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
  at: 'at=VersionType eq 'Configured'', # String | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.
  tags: 'tags_example' # String | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.
}

begin
  # Read a 'chassis.IomProfile' resource.
  result = api_instance.get_chassis_iom_profile_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_iom_profile_list: #{e}"
end

Using the get_chassis_iom_profile_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_iom_profile_list_with_http_info(opts)

begin
  # Read a 'chassis.IomProfile' resource.
  data, status_code, headers = api_instance.get_chassis_iom_profile_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisIomProfileResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_iom_profile_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). [optional][default to '']
orderby String Determines what properties are used to sort the collection of resources. [optional]
top Integer Specifies the maximum number of resources to return in the response. [optional][default to 100]
skip Integer Specifies the number of resources to skip in the response. [optional][default to 0]
select String Specifies a subset of properties to return. [optional][default to '']
expand String Specify additional attributes or related resources to return in addition to the primary resources. [optional]
apply String Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. [optional]
count Boolean The $count query specifies the service should return the count of the matching resources, instead of returning the resources. [optional]
inlinecount String The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. [optional][default to 'allpages']
at String Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. [optional]
tags String The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. [optional]

Return type

ChassisIomProfileResponse

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_profile_by_moid

get_chassis_profile_by_moid(moid)

Read a 'chassis.Profile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'chassis.Profile' resource.
  result = api_instance.get_chassis_profile_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_profile_by_moid: #{e}"
end

Using the get_chassis_profile_by_moid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_profile_by_moid_with_http_info(moid)

begin
  # Read a 'chassis.Profile' resource.
  data, status_code, headers = api_instance.get_chassis_profile_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisProfile>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_profile_by_moid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.

Return type

ChassisProfile

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get_chassis_profile_list

get_chassis_profile_list(opts)

Read a 'chassis.Profile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
opts = {
  filter: '$filter=CreateTime gt 2012-08-29T21:58:33Z', # String | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).
  orderby: '$orderby=CreationTime', # String | Determines what properties are used to sort the collection of resources.
  top: $top=10, # Integer | Specifies the maximum number of resources to return in the response.
  skip: $skip=100, # Integer | Specifies the number of resources to skip in the response.
  select: '$select=CreateTime,ModTime', # String | Specifies a subset of properties to return.
  expand: '$expand=DisplayNames', # String | Specify additional attributes or related resources to return in addition to the primary resources.
  apply: 'apply_example', # String | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.
  count: false, # Boolean | The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
  inlinecount: 'allpages', # String | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
  at: 'at=VersionType eq 'Configured'', # String | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.
  tags: 'tags_example' # String | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.
}

begin
  # Read a 'chassis.Profile' resource.
  result = api_instance.get_chassis_profile_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_profile_list: #{e}"
end

Using the get_chassis_profile_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_chassis_profile_list_with_http_info(opts)

begin
  # Read a 'chassis.Profile' resource.
  data, status_code, headers = api_instance.get_chassis_profile_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisProfileResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->get_chassis_profile_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). [optional][default to '']
orderby String Determines what properties are used to sort the collection of resources. [optional]
top Integer Specifies the maximum number of resources to return in the response. [optional][default to 100]
skip Integer Specifies the number of resources to skip in the response. [optional][default to 0]
select String Specifies a subset of properties to return. [optional][default to '']
expand String Specify additional attributes or related resources to return in addition to the primary resources. [optional]
apply String Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. [optional]
count Boolean The $count query specifies the service should return the count of the matching resources, instead of returning the resources. [optional]
inlinecount String The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. [optional][default to 'allpages']
at String Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. [optional]
tags String The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. [optional]

Return type

ChassisProfileResponse

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

patch_chassis_profile

patch_chassis_profile(moid, chassis_profile, opts)

Update a 'chassis.Profile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
chassis_profile = IntersightClient::ChassisProfile.new({class_id: 'chassis.Profile', object_type: 'chassis.Profile'}) # ChassisProfile | The 'chassis.Profile' resource to update.
opts = {
  if_match: 'if_match_example' # String | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.
}

begin
  # Update a 'chassis.Profile' resource.
  result = api_instance.patch_chassis_profile(moid, chassis_profile, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->patch_chassis_profile: #{e}"
end

Using the patch_chassis_profile_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_chassis_profile_with_http_info(moid, chassis_profile, opts)

begin
  # Update a 'chassis.Profile' resource.
  data, status_code, headers = api_instance.patch_chassis_profile_with_http_info(moid, chassis_profile, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisProfile>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->patch_chassis_profile_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
chassis_profile ChassisProfile The 'chassis.Profile' resource to update.
if_match String For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. [optional]

Return type

ChassisProfile

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: application/json, application/json-patch+json
  • Accept: application/json

update_chassis_profile

update_chassis_profile(moid, chassis_profile, opts)

Update a 'chassis.Profile' resource.

Examples

require 'time'
require 'intersight_client'
# setup authorization
IntersightClient.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['cookieAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['cookieAuth'] = 'Bearer'


  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IntersightClient::ChassisApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
chassis_profile = IntersightClient::ChassisProfile.new({class_id: 'chassis.Profile', object_type: 'chassis.Profile'}) # ChassisProfile | The 'chassis.Profile' resource to update.
opts = {
  if_match: 'if_match_example' # String | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.
}

begin
  # Update a 'chassis.Profile' resource.
  result = api_instance.update_chassis_profile(moid, chassis_profile, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->update_chassis_profile: #{e}"
end

Using the update_chassis_profile_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_chassis_profile_with_http_info(moid, chassis_profile, opts)

begin
  # Update a 'chassis.Profile' resource.
  data, status_code, headers = api_instance.update_chassis_profile_with_http_info(moid, chassis_profile, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ChassisProfile>
rescue IntersightClient::ApiError => e
  puts "Error when calling ChassisApi->update_chassis_profile_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
chassis_profile ChassisProfile The 'chassis.Profile' resource to update.
if_match String For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. [optional]

Return type

ChassisProfile

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

  • Content-Type: application/json, application/json-patch+json
  • Accept: application/json