RubyDoc.info: Class: IntersightClient::IppoolApi – Documentation for intersight_client (0.1.3)

#create_ippool_pool(ippool_pool, opts = {}) ⇒ `IppoolPool`

Create a ‘ippool.Pool’ resource.

Parameters:

ippool_pool (IppoolPool) —

The 'ippool.Pool' resource to create.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.
: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.

Returns:

(IppoolPool)

# File 'lib/intersight_client/api/ippool_api.rb', line 28

def create_ippool_pool(ippool_pool, opts = {})
  data, _status_code, _headers = create_ippool_pool_with_http_info(ippool_pool, opts)
  data
end

#create_ippool_pool_with_http_info(ippool_pool, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`

Create a 'ippool.Pool' resource.

Parameters:

ippool_pool (IppoolPool) —

The 'ippool.Pool' resource to create.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.
: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.

Returns:

(Array<(IppoolPool, Integer, Hash)>) —

IppoolPool data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 39

def create_ippool_pool_with_http_info(ippool_pool, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.create_ippool_pool ...'
  end
  # verify the required parameter 'ippool_pool' is set
  if @api_client.config.client_side_validation && ippool_pool.nil?
    fail ArgumentError, "Missing the required parameter 'ippool_pool' when calling IppoolApi.create_ippool_pool"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Pools'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(ippool_pool)

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.create_ippool_pool",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#create_ippool_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_ippool_ip_lease(moid, opts = {}) ⇒ `nil`

Delete a ‘ippool.IpLease’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/intersight_client/api/ippool_api.rb', line 98

def delete_ippool_ip_lease(moid, opts = {})
  delete_ippool_ip_lease_with_http_info(moid, opts)
  nil
end

#delete_ippool_ip_lease_with_http_info(moid, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

Delete a 'ippool.IpLease' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 107

def delete_ippool_ip_lease_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.delete_ippool_ip_lease ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.delete_ippool_ip_lease"
  end
  # resource path
  local_var_path = '/api/v1/ippool/IpLeases/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.delete_ippool_ip_lease",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#delete_ippool_ip_lease\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_ippool_pool(moid, opts = {}) ⇒ `nil`

Delete a ‘ippool.Pool’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/intersight_client/api/ippool_api.rb', line 159

def delete_ippool_pool(moid, opts = {})
  delete_ippool_pool_with_http_info(moid, opts)
  nil
end

#delete_ippool_pool_with_http_info(moid, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

Delete a 'ippool.Pool' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 168

def delete_ippool_pool_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.delete_ippool_pool ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.delete_ippool_pool"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Pools/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.delete_ippool_pool",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#delete_ippool_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_block_lease_by_moid(moid, opts = {}) ⇒ `IppoolBlockLease`

Read a ‘ippool.BlockLease’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(IppoolBlockLease)

# File 'lib/intersight_client/api/ippool_api.rb', line 220

def get_ippool_block_lease_by_moid(moid, opts = {})
  data, _status_code, _headers = get_ippool_block_lease_by_moid_with_http_info(moid, opts)
  data
end

#get_ippool_block_lease_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolBlockLease, Integer, Hash)>`

Read a 'ippool.BlockLease' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(IppoolBlockLease, Integer, Hash)>) —

IppoolBlockLease data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 229

def get_ippool_block_lease_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_block_lease_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.get_ippool_block_lease_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/ippool/BlockLeases/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolBlockLease'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_block_lease_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_block_lease_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_block_lease_list(opts = {}) ⇒ `IppoolBlockLeaseResponse`

Read a ‘ippool.BlockLease’ resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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). (default to ”)
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response. (default to 100)
:skip (Integer) —

Specifies the number of resources to skip in the response. (default to 0)
:select (String) —

Specifies a subset of properties to return. (default to ”)
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)
:at (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 (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.

Returns:

(IppoolBlockLeaseResponse)

# File 'lib/intersight_client/api/ippool_api.rb', line 291

def get_ippool_block_lease_list(opts = {})
  data, _status_code, _headers = get_ippool_block_lease_list_with_http_info(opts)
  data
end

#get_ippool_block_lease_list_with_http_info(opts = {}) ⇒ `Array<(IppoolBlockLeaseResponse, Integer, Hash)>`

Read a 'ippool.BlockLease' resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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).
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response.
:skip (Integer) —

Specifies the number of resources to skip in the response.
:select (String) —

Specifies a subset of properties to return.
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
:at (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 (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.

Returns:

(Array<(IppoolBlockLeaseResponse, Integer, Hash)>) —

IppoolBlockLeaseResponse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 310

def get_ippool_block_lease_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_block_lease_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/ippool/BlockLeases'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolBlockLeaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_block_lease_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_block_lease_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_ip_lease_by_moid(moid, opts = {}) ⇒ `IppoolIpLease`

Read a ‘ippool.IpLease’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(IppoolIpLease)

# File 'lib/intersight_client/api/ippool_api.rb', line 373

def get_ippool_ip_lease_by_moid(moid, opts = {})
  data, _status_code, _headers = get_ippool_ip_lease_by_moid_with_http_info(moid, opts)
  data
end

#get_ippool_ip_lease_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolIpLease, Integer, Hash)>`

Read a 'ippool.IpLease' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(IppoolIpLease, Integer, Hash)>) —

IppoolIpLease data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 382

def get_ippool_ip_lease_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_ip_lease_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.get_ippool_ip_lease_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/ippool/IpLeases/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolIpLease'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_ip_lease_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_ip_lease_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_ip_lease_list(opts = {}) ⇒ `IppoolIpLeaseResponse`

Read a ‘ippool.IpLease’ resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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). (default to ”)
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response. (default to 100)
:skip (Integer) —

Specifies the number of resources to skip in the response. (default to 0)
:select (String) —

Specifies a subset of properties to return. (default to ”)
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)
:at (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 (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.

Returns:

(IppoolIpLeaseResponse)

# File 'lib/intersight_client/api/ippool_api.rb', line 444

def get_ippool_ip_lease_list(opts = {})
  data, _status_code, _headers = get_ippool_ip_lease_list_with_http_info(opts)
  data
end

#get_ippool_ip_lease_list_with_http_info(opts = {}) ⇒ `Array<(IppoolIpLeaseResponse, Integer, Hash)>`

Read a 'ippool.IpLease' resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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).
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response.
:skip (Integer) —

Specifies the number of resources to skip in the response.
:select (String) —

Specifies a subset of properties to return.
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
:at (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 (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.

Returns:

(Array<(IppoolIpLeaseResponse, Integer, Hash)>) —

IppoolIpLeaseResponse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 463

def get_ippool_ip_lease_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_ip_lease_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/ippool/IpLeases'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolIpLeaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_ip_lease_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_ip_lease_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_pool_by_moid(moid, opts = {}) ⇒ `IppoolPool`

Read a ‘ippool.Pool’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(IppoolPool)

# File 'lib/intersight_client/api/ippool_api.rb', line 526

def get_ippool_pool_by_moid(moid, opts = {})
  data, _status_code, _headers = get_ippool_pool_by_moid_with_http_info(moid, opts)
  data
end

#get_ippool_pool_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`

Read a 'ippool.Pool' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(IppoolPool, Integer, Hash)>) —

IppoolPool data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 535

def get_ippool_pool_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_pool_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.get_ippool_pool_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Pools/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_pool_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_pool_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_pool_list(opts = {}) ⇒ `IppoolPoolResponse`

Read a ‘ippool.Pool’ resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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). (default to ”)
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response. (default to 100)
:skip (Integer) —

Specifies the number of resources to skip in the response. (default to 0)
:select (String) —

Specifies a subset of properties to return. (default to ”)
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)
:at (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 (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.

Returns:

(IppoolPoolResponse)

# File 'lib/intersight_client/api/ippool_api.rb', line 597

def get_ippool_pool_list(opts = {})
  data, _status_code, _headers = get_ippool_pool_list_with_http_info(opts)
  data
end

#get_ippool_pool_list_with_http_info(opts = {}) ⇒ `Array<(IppoolPoolResponse, Integer, Hash)>`

Read a 'ippool.Pool' resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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).
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response.
:skip (Integer) —

Specifies the number of resources to skip in the response.
:select (String) —

Specifies a subset of properties to return.
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
:at (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 (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.

Returns:

(Array<(IppoolPoolResponse, Integer, Hash)>) —

IppoolPoolResponse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 616

def get_ippool_pool_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_pool_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Pools'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolPoolResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_pool_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_pool_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_pool_member_by_moid(moid, opts = {}) ⇒ `IppoolPoolMember`

Read a ‘ippool.PoolMember’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(IppoolPoolMember)

# File 'lib/intersight_client/api/ippool_api.rb', line 679

def get_ippool_pool_member_by_moid(moid, opts = {})
  data, _status_code, _headers = get_ippool_pool_member_by_moid_with_http_info(moid, opts)
  data
end

#get_ippool_pool_member_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolPoolMember, Integer, Hash)>`

Read a 'ippool.PoolMember' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(IppoolPoolMember, Integer, Hash)>) —

IppoolPoolMember data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 688

def get_ippool_pool_member_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_pool_member_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.get_ippool_pool_member_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/ippool/PoolMembers/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolPoolMember'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_pool_member_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_pool_member_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_pool_member_list(opts = {}) ⇒ `IppoolPoolMemberResponse`

Read a ‘ippool.PoolMember’ resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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). (default to ”)
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response. (default to 100)
:skip (Integer) —

Specifies the number of resources to skip in the response. (default to 0)
:select (String) —

Specifies a subset of properties to return. (default to ”)
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)
:at (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 (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.

Returns:

(IppoolPoolMemberResponse)

# File 'lib/intersight_client/api/ippool_api.rb', line 750

def get_ippool_pool_member_list(opts = {})
  data, _status_code, _headers = get_ippool_pool_member_list_with_http_info(opts)
  data
end

#get_ippool_pool_member_list_with_http_info(opts = {}) ⇒ `Array<(IppoolPoolMemberResponse, Integer, Hash)>`

Read a 'ippool.PoolMember' resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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).
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response.
:skip (Integer) —

Specifies the number of resources to skip in the response.
:select (String) —

Specifies a subset of properties to return.
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
:at (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 (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.

Returns:

(Array<(IppoolPoolMemberResponse, Integer, Hash)>) —

IppoolPoolMemberResponse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 769

def get_ippool_pool_member_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_pool_member_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/ippool/PoolMembers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolPoolMemberResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_pool_member_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_pool_member_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_shadow_block_by_moid(moid, opts = {}) ⇒ `IppoolShadowBlock`

Read a ‘ippool.ShadowBlock’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(IppoolShadowBlock)

# File 'lib/intersight_client/api/ippool_api.rb', line 832

def get_ippool_shadow_block_by_moid(moid, opts = {})
  data, _status_code, _headers = get_ippool_shadow_block_by_moid_with_http_info(moid, opts)
  data
end

#get_ippool_shadow_block_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolShadowBlock, Integer, Hash)>`

Read a 'ippool.ShadowBlock' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(IppoolShadowBlock, Integer, Hash)>) —

IppoolShadowBlock data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 841

def get_ippool_shadow_block_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_shadow_block_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.get_ippool_shadow_block_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/ippool/ShadowBlocks/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolShadowBlock'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_shadow_block_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_shadow_block_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_shadow_block_list(opts = {}) ⇒ `IppoolShadowBlockResponse`

Read a ‘ippool.ShadowBlock’ resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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). (default to ”)
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response. (default to 100)
:skip (Integer) —

Specifies the number of resources to skip in the response. (default to 0)
:select (String) —

Specifies a subset of properties to return. (default to ”)
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)
:at (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 (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.

Returns:

(IppoolShadowBlockResponse)

# File 'lib/intersight_client/api/ippool_api.rb', line 903

def get_ippool_shadow_block_list(opts = {})
  data, _status_code, _headers = get_ippool_shadow_block_list_with_http_info(opts)
  data
end

#get_ippool_shadow_block_list_with_http_info(opts = {}) ⇒ `Array<(IppoolShadowBlockResponse, Integer, Hash)>`

Read a 'ippool.ShadowBlock' resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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).
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response.
:skip (Integer) —

Specifies the number of resources to skip in the response.
:select (String) —

Specifies a subset of properties to return.
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
:at (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 (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.

Returns:

(Array<(IppoolShadowBlockResponse, Integer, Hash)>) —

IppoolShadowBlockResponse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 922

def get_ippool_shadow_block_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_shadow_block_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/ippool/ShadowBlocks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolShadowBlockResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_shadow_block_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_shadow_block_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_shadow_pool_by_moid(moid, opts = {}) ⇒ `IppoolShadowPool`

Read a ‘ippool.ShadowPool’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(IppoolShadowPool)

# File 'lib/intersight_client/api/ippool_api.rb', line 985

def get_ippool_shadow_pool_by_moid(moid, opts = {})
  data, _status_code, _headers = get_ippool_shadow_pool_by_moid_with_http_info(moid, opts)
  data
end

#get_ippool_shadow_pool_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolShadowPool, Integer, Hash)>`

Read a 'ippool.ShadowPool' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(IppoolShadowPool, Integer, Hash)>) —

IppoolShadowPool data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 994

def get_ippool_shadow_pool_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_shadow_pool_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.get_ippool_shadow_pool_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/ippool/ShadowPools/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolShadowPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_shadow_pool_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_shadow_pool_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_shadow_pool_list(opts = {}) ⇒ `IppoolShadowPoolResponse`

Read a ‘ippool.ShadowPool’ resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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). (default to ”)
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response. (default to 100)
:skip (Integer) —

Specifies the number of resources to skip in the response. (default to 0)
:select (String) —

Specifies a subset of properties to return. (default to ”)
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)
:at (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 (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.

Returns:

(IppoolShadowPoolResponse)

# File 'lib/intersight_client/api/ippool_api.rb', line 1056

def get_ippool_shadow_pool_list(opts = {})
  data, _status_code, _headers = get_ippool_shadow_pool_list_with_http_info(opts)
  data
end

#get_ippool_shadow_pool_list_with_http_info(opts = {}) ⇒ `Array<(IppoolShadowPoolResponse, Integer, Hash)>`

Read a 'ippool.ShadowPool' resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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).
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response.
:skip (Integer) —

Specifies the number of resources to skip in the response.
:select (String) —

Specifies a subset of properties to return.
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
:at (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 (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.

Returns:

(Array<(IppoolShadowPoolResponse, Integer, Hash)>) —

IppoolShadowPoolResponse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 1075

def get_ippool_shadow_pool_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_shadow_pool_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/ippool/ShadowPools'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolShadowPoolResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_shadow_pool_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_shadow_pool_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_universe_by_moid(moid, opts = {}) ⇒ `IppoolUniverse`

Read a ‘ippool.Universe’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(IppoolUniverse)

# File 'lib/intersight_client/api/ippool_api.rb', line 1138

def get_ippool_universe_by_moid(moid, opts = {})
  data, _status_code, _headers = get_ippool_universe_by_moid_with_http_info(moid, opts)
  data
end

#get_ippool_universe_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolUniverse, Integer, Hash)>`

Read a 'ippool.Universe' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(IppoolUniverse, Integer, Hash)>) —

IppoolUniverse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 1147

def get_ippool_universe_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_universe_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.get_ippool_universe_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Universes/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolUniverse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_universe_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_universe_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ippool_universe_list(opts = {}) ⇒ `IppoolUniverseResponse`

Read a ‘ippool.Universe’ resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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). (default to ”)
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response. (default to 100)
:skip (Integer) —

Specifies the number of resources to skip in the response. (default to 0)
:select (String) —

Specifies a subset of properties to return. (default to ”)
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)
:at (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 (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.

Returns:

(IppoolUniverseResponse)

# File 'lib/intersight_client/api/ippool_api.rb', line 1209

def get_ippool_universe_list(opts = {})
  data, _status_code, _headers = get_ippool_universe_list_with_http_info(opts)
  data
end

#get_ippool_universe_list_with_http_info(opts = {}) ⇒ `Array<(IppoolUniverseResponse, Integer, Hash)>`

Read a 'ippool.Universe' resource.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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).
:orderby (String) —

Determines what properties are used to sort the collection of resources.
:top (Integer) —

Specifies the maximum number of resources to return in the response.
:skip (Integer) —

Specifies the number of resources to skip in the response.
:select (String) —

Specifies a subset of properties to return.
:expand (String) —

Specify additional attributes or related resources to return in addition to the primary resources.
: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 "$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 (Boolean) —

The $count query specifies the service should return the count of the matching resources, instead of returning the resources.
:inlinecount (String) —

The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.
:at (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 (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.

Returns:

(Array<(IppoolUniverseResponse, Integer, Hash)>) —

IppoolUniverseResponse data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 1228

def get_ippool_universe_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.get_ippool_universe_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Universes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolUniverseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.get_ippool_universe_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#get_ippool_universe_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_ippool_pool(moid, ippool_pool, opts = {}) ⇒ `IppoolPool`

Update a ‘ippool.Pool’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
ippool_pool (IppoolPool) —

The 'ippool.Pool' resource to update.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.

Returns:

(IppoolPool)

# File 'lib/intersight_client/api/ippool_api.rb', line 1293

def patch_ippool_pool(moid, ippool_pool, opts = {})
  data, _status_code, _headers = patch_ippool_pool_with_http_info(moid, ippool_pool, opts)
  data
end

#patch_ippool_pool_with_http_info(moid, ippool_pool, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`

Update a 'ippool.Pool' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
ippool_pool (IppoolPool) —

The 'ippool.Pool' resource to update.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.

Returns:

(Array<(IppoolPool, Integer, Hash)>) —

IppoolPool data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 1304

def patch_ippool_pool_with_http_info(moid, ippool_pool, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.patch_ippool_pool ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.patch_ippool_pool"
  end
  # verify the required parameter 'ippool_pool' is set
  if @api_client.config.client_side_validation && ippool_pool.nil?
    fail ArgumentError, "Missing the required parameter 'ippool_pool' when calling IppoolApi.patch_ippool_pool"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Pools/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/json-patch+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(ippool_pool)

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.patch_ippool_pool",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#patch_ippool_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_ippool_pool(moid, ippool_pool, opts = {}) ⇒ `IppoolPool`

Update a ‘ippool.Pool’ resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
ippool_pool (IppoolPool) —

The 'ippool.Pool' resource to update.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.

Returns:

(IppoolPool)

# File 'lib/intersight_client/api/ippool_api.rb', line 1368

def update_ippool_pool(moid, ippool_pool, opts = {})
  data, _status_code, _headers = update_ippool_pool_with_http_info(moid, ippool_pool, opts)
  data
end

#update_ippool_pool_with_http_info(moid, ippool_pool, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`

Update a 'ippool.Pool' resource.

Parameters:

moid (String) —

The unique Moid identifier of a resource instance.
ippool_pool (IppoolPool) —

The 'ippool.Pool' resource to update.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.

Returns:

(Array<(IppoolPool, Integer, Hash)>) —

IppoolPool data, response status code and response headers

# File 'lib/intersight_client/api/ippool_api.rb', line 1379

def update_ippool_pool_with_http_info(moid, ippool_pool, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IppoolApi.update_ippool_pool ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling IppoolApi.update_ippool_pool"
  end
  # verify the required parameter 'ippool_pool' is set
  if @api_client.config.client_side_validation && ippool_pool.nil?
    fail ArgumentError, "Missing the required parameter 'ippool_pool' when calling IppoolApi.update_ippool_pool"
  end
  # resource path
  local_var_path = '/api/v1/ippool/Pools/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/json-patch+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(ippool_pool)

  # return_type
  return_type = opts[:debug_return_type] || 'IppoolPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"IppoolApi.update_ippool_pool",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IppoolApi#update_ippool_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Class: IntersightClient::IppoolApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IppoolApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#create_ippool_pool(ippool_pool, opts = {}) ⇒ IppoolPool

#create_ippool_pool_with_http_info(ippool_pool, opts = {}) ⇒ Array<(IppoolPool, Integer, Hash)>

#delete_ippool_ip_lease(moid, opts = {}) ⇒ nil

#delete_ippool_ip_lease_with_http_info(moid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#delete_ippool_pool(moid, opts = {}) ⇒ nil

#delete_ippool_pool_with_http_info(moid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#get_ippool_block_lease_by_moid(moid, opts = {}) ⇒ IppoolBlockLease

#get_ippool_block_lease_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IppoolBlockLease, Integer, Hash)>

#get_ippool_block_lease_list(opts = {}) ⇒ IppoolBlockLeaseResponse

#get_ippool_block_lease_list_with_http_info(opts = {}) ⇒ Array<(IppoolBlockLeaseResponse, Integer, Hash)>

#get_ippool_ip_lease_by_moid(moid, opts = {}) ⇒ IppoolIpLease

#get_ippool_ip_lease_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IppoolIpLease, Integer, Hash)>

#get_ippool_ip_lease_list(opts = {}) ⇒ IppoolIpLeaseResponse

#get_ippool_ip_lease_list_with_http_info(opts = {}) ⇒ Array<(IppoolIpLeaseResponse, Integer, Hash)>

#get_ippool_pool_by_moid(moid, opts = {}) ⇒ IppoolPool

#get_ippool_pool_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IppoolPool, Integer, Hash)>

#get_ippool_pool_list(opts = {}) ⇒ IppoolPoolResponse

#get_ippool_pool_list_with_http_info(opts = {}) ⇒ Array<(IppoolPoolResponse, Integer, Hash)>

#get_ippool_pool_member_by_moid(moid, opts = {}) ⇒ IppoolPoolMember

#get_ippool_pool_member_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IppoolPoolMember, Integer, Hash)>

#get_ippool_pool_member_list(opts = {}) ⇒ IppoolPoolMemberResponse

#get_ippool_pool_member_list_with_http_info(opts = {}) ⇒ Array<(IppoolPoolMemberResponse, Integer, Hash)>

#get_ippool_shadow_block_by_moid(moid, opts = {}) ⇒ IppoolShadowBlock

#get_ippool_shadow_block_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IppoolShadowBlock, Integer, Hash)>

#get_ippool_shadow_block_list(opts = {}) ⇒ IppoolShadowBlockResponse

#get_ippool_shadow_block_list_with_http_info(opts = {}) ⇒ Array<(IppoolShadowBlockResponse, Integer, Hash)>

#get_ippool_shadow_pool_by_moid(moid, opts = {}) ⇒ IppoolShadowPool

#get_ippool_shadow_pool_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IppoolShadowPool, Integer, Hash)>

#get_ippool_shadow_pool_list(opts = {}) ⇒ IppoolShadowPoolResponse

#get_ippool_shadow_pool_list_with_http_info(opts = {}) ⇒ Array<(IppoolShadowPoolResponse, Integer, Hash)>

#get_ippool_universe_by_moid(moid, opts = {}) ⇒ IppoolUniverse

#get_ippool_universe_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IppoolUniverse, Integer, Hash)>

#get_ippool_universe_list(opts = {}) ⇒ IppoolUniverseResponse

#get_ippool_universe_list_with_http_info(opts = {}) ⇒ Array<(IppoolUniverseResponse, Integer, Hash)>

#patch_ippool_pool(moid, ippool_pool, opts = {}) ⇒ IppoolPool

#patch_ippool_pool_with_http_info(moid, ippool_pool, opts = {}) ⇒ Array<(IppoolPool, Integer, Hash)>

#update_ippool_pool(moid, ippool_pool, opts = {}) ⇒ IppoolPool

#update_ippool_pool_with_http_info(moid, ippool_pool, opts = {}) ⇒ Array<(IppoolPool, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `IppoolApi`

#api_client ⇒ `Object`

#create_ippool_pool(ippool_pool, opts = {}) ⇒ `IppoolPool`

#create_ippool_pool_with_http_info(ippool_pool, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`

#delete_ippool_ip_lease(moid, opts = {}) ⇒ `nil`

#delete_ippool_ip_lease_with_http_info(moid, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#delete_ippool_pool(moid, opts = {}) ⇒ `nil`

#delete_ippool_pool_with_http_info(moid, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#get_ippool_block_lease_by_moid(moid, opts = {}) ⇒ `IppoolBlockLease`

#get_ippool_block_lease_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolBlockLease, Integer, Hash)>`

#get_ippool_block_lease_list(opts = {}) ⇒ `IppoolBlockLeaseResponse`

#get_ippool_block_lease_list_with_http_info(opts = {}) ⇒ `Array<(IppoolBlockLeaseResponse, Integer, Hash)>`

#get_ippool_ip_lease_by_moid(moid, opts = {}) ⇒ `IppoolIpLease`

#get_ippool_ip_lease_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolIpLease, Integer, Hash)>`

#get_ippool_ip_lease_list(opts = {}) ⇒ `IppoolIpLeaseResponse`

#get_ippool_ip_lease_list_with_http_info(opts = {}) ⇒ `Array<(IppoolIpLeaseResponse, Integer, Hash)>`

#get_ippool_pool_by_moid(moid, opts = {}) ⇒ `IppoolPool`

#get_ippool_pool_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`

#get_ippool_pool_list(opts = {}) ⇒ `IppoolPoolResponse`

#get_ippool_pool_list_with_http_info(opts = {}) ⇒ `Array<(IppoolPoolResponse, Integer, Hash)>`

#get_ippool_pool_member_by_moid(moid, opts = {}) ⇒ `IppoolPoolMember`

#get_ippool_pool_member_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolPoolMember, Integer, Hash)>`

#get_ippool_pool_member_list(opts = {}) ⇒ `IppoolPoolMemberResponse`

#get_ippool_pool_member_list_with_http_info(opts = {}) ⇒ `Array<(IppoolPoolMemberResponse, Integer, Hash)>`

#get_ippool_shadow_block_by_moid(moid, opts = {}) ⇒ `IppoolShadowBlock`

#get_ippool_shadow_block_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolShadowBlock, Integer, Hash)>`

#get_ippool_shadow_block_list(opts = {}) ⇒ `IppoolShadowBlockResponse`

#get_ippool_shadow_block_list_with_http_info(opts = {}) ⇒ `Array<(IppoolShadowBlockResponse, Integer, Hash)>`

#get_ippool_shadow_pool_by_moid(moid, opts = {}) ⇒ `IppoolShadowPool`

#get_ippool_shadow_pool_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolShadowPool, Integer, Hash)>`

#get_ippool_shadow_pool_list(opts = {}) ⇒ `IppoolShadowPoolResponse`

#get_ippool_shadow_pool_list_with_http_info(opts = {}) ⇒ `Array<(IppoolShadowPoolResponse, Integer, Hash)>`

#get_ippool_universe_by_moid(moid, opts = {}) ⇒ `IppoolUniverse`

#get_ippool_universe_by_moid_with_http_info(moid, opts = {}) ⇒ `Array<(IppoolUniverse, Integer, Hash)>`

#get_ippool_universe_list(opts = {}) ⇒ `IppoolUniverseResponse`

#get_ippool_universe_list_with_http_info(opts = {}) ⇒ `Array<(IppoolUniverseResponse, Integer, Hash)>`

#patch_ippool_pool(moid, ippool_pool, opts = {}) ⇒ `IppoolPool`

#patch_ippool_pool_with_http_info(moid, ippool_pool, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`

#update_ippool_pool(moid, ippool_pool, opts = {}) ⇒ `IppoolPool`

#update_ippool_pool_with_http_info(moid, ippool_pool, opts = {}) ⇒ `Array<(IppoolPool, Integer, Hash)>`