Skip to content

Latest commit

 

History

History
1033 lines (754 loc) · 63.4 KB

File metadata and controls

1033 lines (754 loc) · 63.4 KB

IntersightClient::PortApi

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

Method HTTP request Description
get_port_group_by_moid GET /api/v1/port/Groups/{Moid} Read a 'port.Group' resource.
get_port_group_list GET /api/v1/port/Groups Read a 'port.Group' resource.
get_port_mac_binding_by_moid GET /api/v1/port/MacBindings/{Moid} Read a 'port.MacBinding' resource.
get_port_mac_binding_list GET /api/v1/port/MacBindings Read a 'port.MacBinding' resource.
get_port_sub_group_by_moid GET /api/v1/port/SubGroups/{Moid} Read a 'port.SubGroup' resource.
get_port_sub_group_list GET /api/v1/port/SubGroups Read a 'port.SubGroup' resource.
patch_port_group PATCH /api/v1/port/Groups/{Moid} Update a 'port.Group' resource.
patch_port_mac_binding PATCH /api/v1/port/MacBindings/{Moid} Update a 'port.MacBinding' resource.
patch_port_sub_group PATCH /api/v1/port/SubGroups/{Moid} Update a 'port.SubGroup' resource.
update_port_group POST /api/v1/port/Groups/{Moid} Update a 'port.Group' resource.
update_port_mac_binding POST /api/v1/port/MacBindings/{Moid} Update a 'port.MacBinding' resource.
update_port_sub_group POST /api/v1/port/SubGroups/{Moid} Update a 'port.SubGroup' resource.

get_port_group_by_moid

get_port_group_by_moid(moid)

Read a 'port.Group' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'port.Group' resource.
  result = api_instance.get_port_group_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_group_by_moid: #{e}"
end

Using the get_port_group_by_moid_with_http_info variant

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

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

begin
  # Read a 'port.Group' resource.
  data, status_code, headers = api_instance.get_port_group_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortGroup>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_group_by_moid_with_http_info: #{e}"
end

Parameters

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

Return type

PortGroup

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_port_group_list

get_port_group_list(opts)

Read a 'port.Group' 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::PortApi.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 'port.Group' resource.
  result = api_instance.get_port_group_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_group_list: #{e}"
end

Using the get_port_group_list_with_http_info variant

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

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

begin
  # Read a 'port.Group' resource.
  data, status_code, headers = api_instance.get_port_group_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortGroupResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_group_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

PortGroupResponse

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_port_mac_binding_by_moid

get_port_mac_binding_by_moid(moid)

Read a 'port.MacBinding' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'port.MacBinding' resource.
  result = api_instance.get_port_mac_binding_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_mac_binding_by_moid: #{e}"
end

Using the get_port_mac_binding_by_moid_with_http_info variant

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

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

begin
  # Read a 'port.MacBinding' resource.
  data, status_code, headers = api_instance.get_port_mac_binding_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortMacBinding>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_mac_binding_by_moid_with_http_info: #{e}"
end

Parameters

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

Return type

PortMacBinding

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_port_mac_binding_list

get_port_mac_binding_list(opts)

Read a 'port.MacBinding' 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::PortApi.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 'port.MacBinding' resource.
  result = api_instance.get_port_mac_binding_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_mac_binding_list: #{e}"
end

Using the get_port_mac_binding_list_with_http_info variant

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

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

begin
  # Read a 'port.MacBinding' resource.
  data, status_code, headers = api_instance.get_port_mac_binding_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortMacBindingResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_mac_binding_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

PortMacBindingResponse

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_port_sub_group_by_moid

get_port_sub_group_by_moid(moid)

Read a 'port.SubGroup' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.

begin
  # Read a 'port.SubGroup' resource.
  result = api_instance.get_port_sub_group_by_moid(moid)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_sub_group_by_moid: #{e}"
end

Using the get_port_sub_group_by_moid_with_http_info variant

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

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

begin
  # Read a 'port.SubGroup' resource.
  data, status_code, headers = api_instance.get_port_sub_group_by_moid_with_http_info(moid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortSubGroup>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_sub_group_by_moid_with_http_info: #{e}"
end

Parameters

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

Return type

PortSubGroup

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_port_sub_group_list

get_port_sub_group_list(opts)

Read a 'port.SubGroup' 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::PortApi.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 'port.SubGroup' resource.
  result = api_instance.get_port_sub_group_list(opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_sub_group_list: #{e}"
end

Using the get_port_sub_group_list_with_http_info variant

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

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

begin
  # Read a 'port.SubGroup' resource.
  data, status_code, headers = api_instance.get_port_sub_group_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortSubGroupResponse>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->get_port_sub_group_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

PortSubGroupResponse

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_port_group

patch_port_group(moid, port_group, opts)

Update a 'port.Group' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
port_group = IntersightClient::PortGroup.new({class_id: 'port.Group', object_type: 'port.Group'}) # PortGroup | The 'port.Group' 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 'port.Group' resource.
  result = api_instance.patch_port_group(moid, port_group, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->patch_port_group: #{e}"
end

Using the patch_port_group_with_http_info variant

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

<Array(, Integer, Hash)> patch_port_group_with_http_info(moid, port_group, opts)

begin
  # Update a 'port.Group' resource.
  data, status_code, headers = api_instance.patch_port_group_with_http_info(moid, port_group, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortGroup>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->patch_port_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
port_group PortGroup The 'port.Group' 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

PortGroup

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

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

patch_port_mac_binding

patch_port_mac_binding(moid, port_mac_binding, opts)

Update a 'port.MacBinding' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
port_mac_binding = IntersightClient::PortMacBinding.new({class_id: 'port.MacBinding', object_type: 'port.MacBinding'}) # PortMacBinding | The 'port.MacBinding' 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 'port.MacBinding' resource.
  result = api_instance.patch_port_mac_binding(moid, port_mac_binding, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->patch_port_mac_binding: #{e}"
end

Using the patch_port_mac_binding_with_http_info variant

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

<Array(, Integer, Hash)> patch_port_mac_binding_with_http_info(moid, port_mac_binding, opts)

begin
  # Update a 'port.MacBinding' resource.
  data, status_code, headers = api_instance.patch_port_mac_binding_with_http_info(moid, port_mac_binding, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortMacBinding>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->patch_port_mac_binding_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
port_mac_binding PortMacBinding The 'port.MacBinding' 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

PortMacBinding

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

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

patch_port_sub_group

patch_port_sub_group(moid, port_sub_group, opts)

Update a 'port.SubGroup' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
port_sub_group = IntersightClient::PortSubGroup.new({class_id: 'port.SubGroup', object_type: 'port.SubGroup'}) # PortSubGroup | The 'port.SubGroup' 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 'port.SubGroup' resource.
  result = api_instance.patch_port_sub_group(moid, port_sub_group, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->patch_port_sub_group: #{e}"
end

Using the patch_port_sub_group_with_http_info variant

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

<Array(, Integer, Hash)> patch_port_sub_group_with_http_info(moid, port_sub_group, opts)

begin
  # Update a 'port.SubGroup' resource.
  data, status_code, headers = api_instance.patch_port_sub_group_with_http_info(moid, port_sub_group, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortSubGroup>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->patch_port_sub_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
port_sub_group PortSubGroup The 'port.SubGroup' 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

PortSubGroup

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

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

update_port_group

update_port_group(moid, port_group, opts)

Update a 'port.Group' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
port_group = IntersightClient::PortGroup.new({class_id: 'port.Group', object_type: 'port.Group'}) # PortGroup | The 'port.Group' 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 'port.Group' resource.
  result = api_instance.update_port_group(moid, port_group, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->update_port_group: #{e}"
end

Using the update_port_group_with_http_info variant

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

<Array(, Integer, Hash)> update_port_group_with_http_info(moid, port_group, opts)

begin
  # Update a 'port.Group' resource.
  data, status_code, headers = api_instance.update_port_group_with_http_info(moid, port_group, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortGroup>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->update_port_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
port_group PortGroup The 'port.Group' 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

PortGroup

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

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

update_port_mac_binding

update_port_mac_binding(moid, port_mac_binding, opts)

Update a 'port.MacBinding' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
port_mac_binding = IntersightClient::PortMacBinding.new({class_id: 'port.MacBinding', object_type: 'port.MacBinding'}) # PortMacBinding | The 'port.MacBinding' 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 'port.MacBinding' resource.
  result = api_instance.update_port_mac_binding(moid, port_mac_binding, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->update_port_mac_binding: #{e}"
end

Using the update_port_mac_binding_with_http_info variant

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

<Array(, Integer, Hash)> update_port_mac_binding_with_http_info(moid, port_mac_binding, opts)

begin
  # Update a 'port.MacBinding' resource.
  data, status_code, headers = api_instance.update_port_mac_binding_with_http_info(moid, port_mac_binding, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortMacBinding>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->update_port_mac_binding_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
port_mac_binding PortMacBinding The 'port.MacBinding' 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

PortMacBinding

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

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

update_port_sub_group

update_port_sub_group(moid, port_sub_group, opts)

Update a 'port.SubGroup' 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::PortApi.new
moid = 'moid_example' # String | The unique Moid identifier of a resource instance.
port_sub_group = IntersightClient::PortSubGroup.new({class_id: 'port.SubGroup', object_type: 'port.SubGroup'}) # PortSubGroup | The 'port.SubGroup' 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 'port.SubGroup' resource.
  result = api_instance.update_port_sub_group(moid, port_sub_group, opts)
  p result
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->update_port_sub_group: #{e}"
end

Using the update_port_sub_group_with_http_info variant

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

<Array(, Integer, Hash)> update_port_sub_group_with_http_info(moid, port_sub_group, opts)

begin
  # Update a 'port.SubGroup' resource.
  data, status_code, headers = api_instance.update_port_sub_group_with_http_info(moid, port_sub_group, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PortSubGroup>
rescue IntersightClient::ApiError => e
  puts "Error when calling PortApi->update_port_sub_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
moid String The unique Moid identifier of a resource instance.
port_sub_group PortSubGroup The 'port.SubGroup' 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

PortSubGroup

Authorization

cookieAuth, http_signature, oAuth2, oAuth2

HTTP request headers

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