class Nodeum::NasSharesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/nodeum_sdk/api/nas_shares_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_nas_share_by_nas(nas_id, nas_share_body, opts = {}) click to toggle source

Creates a new NAS share. **API Key Scope**: nas_shares / create @param nas_id [String] Numeric ID or name of NAS. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [NasShare]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 28
def create_nas_share_by_nas(nas_id, nas_share_body, opts = {})
  data, _status_code, _headers = create_nas_share_by_nas_with_http_info(nas_id, nas_share_body, opts)
  data
end
create_nas_share_by_nas_with_http_info(nas_id, nas_share_body, opts = {}) click to toggle source

Creates a new NAS share. **API Key Scope**: nas_shares / create @param nas_id [String] Numeric ID or name of NAS. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [Array<(NasShare, Integer, Hash)>] NasShare data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 39
def create_nas_share_by_nas_with_http_info(nas_id, nas_share_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.create_nas_share_by_nas ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.create_nas_share_by_nas"
  end
  # verify the required parameter 'nas_share_body' is set
  if @api_client.config.client_side_validation && nas_share_body.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_body' when calling NasSharesApi.create_nas_share_by_nas"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'NasShare' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#create_nas_share_by_nas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
destroy_nas_share(nas_share_id, opts = {}) click to toggle source

Destroys a specific NAS share. **API Key Scope**: nas_shares / destroy @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [nil]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 97
def destroy_nas_share(nas_share_id, opts = {})
  destroy_nas_share_with_http_info(nas_share_id, opts)
  nil
end
destroy_nas_share_by_nas(nas_id, nas_share_id, opts = {}) click to toggle source

Destroys a specific NAS share. **API Key Scope**: nas_shares / destroy @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [nil]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 158
def destroy_nas_share_by_nas(nas_id, nas_share_id, opts = {})
  destroy_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts)
  nil
end
destroy_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts = {}) click to toggle source

Destroys a specific NAS share. **API Key Scope**: nas_shares / destroy @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 169
def destroy_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.destroy_nas_share_by_nas ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.destroy_nas_share_by_nas"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.destroy_nas_share_by_nas"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares/{nas_share_id}'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#destroy_nas_share_by_nas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
destroy_nas_share_by_pool(pool_id, nas_share_id, opts = {}) click to toggle source

Destroys a specific NAS share. **API Key Scope**: nas_shares / destroy @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [nil]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 224
def destroy_nas_share_by_pool(pool_id, nas_share_id, opts = {})
  destroy_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts)
  nil
end
destroy_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts = {}) click to toggle source

Destroys a specific NAS share. **API Key Scope**: nas_shares / destroy @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 235
def destroy_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.destroy_nas_share_by_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling NasSharesApi.destroy_nas_share_by_pool"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.destroy_nas_share_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/nas_shares/{nas_share_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#destroy_nas_share_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
destroy_nas_share_with_http_info(nas_share_id, opts = {}) click to toggle source

Destroys a specific NAS share. **API Key Scope**: nas_shares / destroy @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 107
def destroy_nas_share_with_http_info(nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.destroy_nas_share ...'
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.destroy_nas_share"
  end
  # resource path
  local_var_path = '/nas_shares/{nas_share_id}'.sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#destroy_nas_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
index_nas_shares(opts = {}) click to toggle source

Lists all NAS shares. **API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :name Filter on name @option opts [String] :path Filter on path @option opts [String] :options Filter on options @option opts [String] :username Filter on username @option opts [String] :nas_id Filter on NAS id @option opts [String] :pool_id Filter on a pool id @return [NasShareCollection]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 298
def index_nas_shares(opts = {})
  data, _status_code, _headers = index_nas_shares_with_http_info(opts)
  data
end
index_nas_shares_by_nas(nas_id, opts = {}) click to toggle source

Lists all NAS shares. **API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password @param nas_id [String] Numeric ID or name of NAS. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :name Filter on name @option opts [String] :path Filter on path @option opts [String] :options Filter on options @option opts [String] :username Filter on username @option opts [String] :pool_id Filter on a pool id @return [NasShareCollection]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 384
def index_nas_shares_by_nas(nas_id, opts = {})
  data, _status_code, _headers = index_nas_shares_by_nas_with_http_info(nas_id, opts)
  data
end
index_nas_shares_by_nas_with_http_info(nas_id, opts = {}) click to toggle source

Lists all NAS shares. **API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password @param nas_id [String] Numeric ID or name of NAS. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :name Filter on name @option opts [String] :path Filter on path @option opts [String] :options Filter on options @option opts [String] :username Filter on username @option opts [String] :pool_id Filter on a pool id @return [Array<(NasShareCollection, Integer, Hash)>] NasShareCollection data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 403
def index_nas_shares_by_nas_with_http_info(nas_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.index_nas_shares_by_nas ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.index_nas_shares_by_nas"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'options'] = opts[:'options'] if !opts[:'options'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
  query_params[:'pool_id'] = opts[:'pool_id'] if !opts[:'pool_id'].nil?

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'NasShareCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#index_nas_shares_by_nas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
index_nas_shares_by_pool(pool_id, opts = {}) click to toggle source

Lists all NAS shares from pool. **API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :name Filter on name @option opts [String] :path Filter on path @option opts [String] :options Filter on options @option opts [String] :username Filter on username @option opts [String] :nas_id Filter on NAS id @return [NasShareCollection]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 473
def index_nas_shares_by_pool(pool_id, opts = {})
  data, _status_code, _headers = index_nas_shares_by_pool_with_http_info(pool_id, opts)
  data
end
index_nas_shares_by_pool_with_http_info(pool_id, opts = {}) click to toggle source

Lists all NAS shares from pool. **API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :name Filter on name @option opts [String] :path Filter on path @option opts [String] :options Filter on options @option opts [String] :username Filter on username @option opts [String] :nas_id Filter on NAS id @return [Array<(NasShareCollection, Integer, Hash)>] NasShareCollection data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 492
def index_nas_shares_by_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.index_nas_shares_by_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling NasSharesApi.index_nas_shares_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/nas_shares'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'options'] = opts[:'options'] if !opts[:'options'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
  query_params[:'nas_id'] = opts[:'nas_id'] if !opts[:'nas_id'].nil?

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'NasShareCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#index_nas_shares_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
index_nas_shares_with_http_info(opts = {}) click to toggle source

Lists all NAS shares. **API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :name Filter on name @option opts [String] :path Filter on path @option opts [String] :options Filter on options @option opts [String] :username Filter on username @option opts [String] :nas_id Filter on NAS id @option opts [String] :pool_id Filter on a pool id @return [Array<(NasShareCollection, Integer, Hash)>] NasShareCollection data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 317
def index_nas_shares_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.index_nas_shares ...'
  end
  # resource path
  local_var_path = '/nas_shares'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'options'] = opts[:'options'] if !opts[:'options'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
  query_params[:'nas_id'] = opts[:'nas_id'] if !opts[:'nas_id'].nil?
  query_params[:'pool_id'] = opts[:'pool_id'] if !opts[:'pool_id'].nil?

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'NasShareCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#index_nas_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
mount_status_nas_share(nas_share_id, opts = {}) click to toggle source

Get mount status of NAS Share. **API Key Scope**: nas_shares / mount_status @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [MountStatus]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 553
def mount_status_nas_share(nas_share_id, opts = {})
  data, _status_code, _headers = mount_status_nas_share_with_http_info(nas_share_id, opts)
  data
end
mount_status_nas_share_by_nas(nas_id, nas_share_id, opts = {}) click to toggle source

Get mount status of NAS Share. **API Key Scope**: nas_shares / mount_status @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [MountStatus]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 616
def mount_status_nas_share_by_nas(nas_id, nas_share_id, opts = {})
  data, _status_code, _headers = mount_status_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts)
  data
end
mount_status_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts = {}) click to toggle source

Get mount status of NAS Share. **API Key Scope**: nas_shares / mount_status @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(MountStatus, Integer, Hash)>] MountStatus data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 627
def mount_status_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.mount_status_nas_share_by_nas ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.mount_status_nas_share_by_nas"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.mount_status_nas_share_by_nas"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares/{nas_share_id}/mount'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'MountStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#mount_status_nas_share_by_nas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
mount_status_nas_share_by_pool(pool_id, nas_share_id, opts = {}) click to toggle source

Get mount status of NAS Share. **API Key Scope**: nas_shares / mount_status @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [MountStatus]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 684
def mount_status_nas_share_by_pool(pool_id, nas_share_id, opts = {})
  data, _status_code, _headers = mount_status_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts)
  data
end
mount_status_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts = {}) click to toggle source

Get mount status of NAS Share. **API Key Scope**: nas_shares / mount_status @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(MountStatus, Integer, Hash)>] MountStatus data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 695
def mount_status_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.mount_status_nas_share_by_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling NasSharesApi.mount_status_nas_share_by_pool"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.mount_status_nas_share_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/nas_shares/{nas_share_id}/mount'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'MountStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#mount_status_nas_share_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
mount_status_nas_share_with_http_info(nas_share_id, opts = {}) click to toggle source

Get mount status of NAS Share. **API Key Scope**: nas_shares / mount_status @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(MountStatus, Integer, Hash)>] MountStatus data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 563
def mount_status_nas_share_with_http_info(nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.mount_status_nas_share ...'
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.mount_status_nas_share"
  end
  # resource path
  local_var_path = '/nas_shares/{nas_share_id}/mount'.sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'MountStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#mount_status_nas_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
show_nas_share(nas_share_id, opts = {}) click to toggle source

Displays a specific NAS share. **API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [NasShare]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 751
def show_nas_share(nas_share_id, opts = {})
  data, _status_code, _headers = show_nas_share_with_http_info(nas_share_id, opts)
  data
end
show_nas_share_by_nas(nas_id, nas_share_id, opts = {}) click to toggle source

Displays a specific NAS share. **API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [NasShare]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 814
def show_nas_share_by_nas(nas_id, nas_share_id, opts = {})
  data, _status_code, _headers = show_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts)
  data
end
show_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts = {}) click to toggle source

Displays a specific NAS share. **API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(NasShare, Integer, Hash)>] NasShare data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 825
def show_nas_share_by_nas_with_http_info(nas_id, nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.show_nas_share_by_nas ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.show_nas_share_by_nas"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.show_nas_share_by_nas"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares/{nas_share_id}'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'NasShare' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#show_nas_share_by_nas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
show_nas_share_by_pool(pool_id, nas_share_id, opts = {}) click to toggle source

Displays a specific NAS share. **API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [NasShare]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 882
def show_nas_share_by_pool(pool_id, nas_share_id, opts = {})
  data, _status_code, _headers = show_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts)
  data
end
show_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts = {}) click to toggle source

Displays a specific NAS share. **API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(NasShare, Integer, Hash)>] NasShare data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 893
def show_nas_share_by_pool_with_http_info(pool_id, nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.show_nas_share_by_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling NasSharesApi.show_nas_share_by_pool"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.show_nas_share_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/nas_shares/{nas_share_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'NasShare' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#show_nas_share_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
show_nas_share_with_http_info(nas_share_id, opts = {}) click to toggle source

Displays a specific NAS share. **API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password @param nas_share_id [String] Numeric ID or name of NAS share. @param [Hash] opts the optional parameters @return [Array<(NasShare, Integer, Hash)>] NasShare data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 761
def show_nas_share_with_http_info(nas_share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.show_nas_share ...'
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.show_nas_share"
  end
  # resource path
  local_var_path = '/nas_shares/{nas_share_id}'.sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'NasShare' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#show_nas_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
test_nas_share(nas_id, nas_share_body, opts = {}) click to toggle source

Test an unsaved NAS Share. **API Key Scope**: nas_shares / test @param nas_id [String] Numeric ID or name of NAS. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [ActiveJobStatus]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 950
def test_nas_share(nas_id, nas_share_body, opts = {})
  data, _status_code, _headers = test_nas_share_with_http_info(nas_id, nas_share_body, opts)
  data
end
test_nas_share_with_http_info(nas_id, nas_share_body, opts = {}) click to toggle source

Test an unsaved NAS Share. **API Key Scope**: nas_shares / test @param nas_id [String] Numeric ID or name of NAS. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 961
def test_nas_share_with_http_info(nas_id, nas_share_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.test_nas_share ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.test_nas_share"
  end
  # verify the required parameter 'nas_share_body' is set
  if @api_client.config.client_side_validation && nas_share_body.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_body' when calling NasSharesApi.test_nas_share"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares/-/test'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.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', 'queued', 'working', 'failed'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'ActiveJobStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NasSharesApi#test_nas_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
test_result_nas_share(nas_id, job_id, opts = {}) click to toggle source

Check result of a NAS Share test job. **API Key Scope**: nas_shares / test @param nas_id [String] Numeric ID or name of NAS. @param job_id [String] ID of active job @param [Hash] opts the optional parameters @return [ActiveJobStatus]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1020
def test_result_nas_share(nas_id, job_id, opts = {})
  data, _status_code, _headers = test_result_nas_share_with_http_info(nas_id, job_id, opts)
  data
end
test_result_nas_share_with_http_info(nas_id, job_id, opts = {}) click to toggle source

Check result of a NAS Share test job. **API Key Scope**: nas_shares / test @param nas_id [String] Numeric ID or name of NAS. @param job_id [String] ID of active job @param [Hash] opts the optional parameters @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1031
def test_result_nas_share_with_http_info(nas_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.test_result_nas_share ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.test_result_nas_share"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling NasSharesApi.test_result_nas_share"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares/-/test'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ActiveJobStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: NasSharesApi#test_result_nas_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_nas_share(nas_share_id, nas_share_body, opts = {}) click to toggle source

Updates a specific NAS share. **API Key Scope**: nas_shares / update @param nas_share_id [String] Numeric ID or name of NAS share. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [NasShare]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1089
def update_nas_share(nas_share_id, nas_share_body, opts = {})
  data, _status_code, _headers = update_nas_share_with_http_info(nas_share_id, nas_share_body, opts)
  data
end
update_nas_share_by_nas(nas_id, nas_share_id, nas_share_body, opts = {}) click to toggle source

Updates a specific NAS share. **API Key Scope**: nas_shares / update @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [NasShare]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1160
def update_nas_share_by_nas(nas_id, nas_share_id, nas_share_body, opts = {})
  data, _status_code, _headers = update_nas_share_by_nas_with_http_info(nas_id, nas_share_id, nas_share_body, opts)
  data
end
update_nas_share_by_nas_with_http_info(nas_id, nas_share_id, nas_share_body, opts = {}) click to toggle source

Updates a specific NAS share. **API Key Scope**: nas_shares / update @param nas_id [String] Numeric ID or name of NAS. @param nas_share_id [String] Numeric ID or name of NAS share. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [Array<(NasShare, Integer, Hash)>] NasShare data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1172
def update_nas_share_by_nas_with_http_info(nas_id, nas_share_id, nas_share_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.update_nas_share_by_nas ...'
  end
  # verify the required parameter 'nas_id' is set
  if @api_client.config.client_side_validation && nas_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_id' when calling NasSharesApi.update_nas_share_by_nas"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.update_nas_share_by_nas"
  end
  # verify the required parameter 'nas_share_body' is set
  if @api_client.config.client_side_validation && nas_share_body.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_body' when calling NasSharesApi.update_nas_share_by_nas"
  end
  # resource path
  local_var_path = '/nas/{nas_id}/nas_shares/{nas_share_id}'.sub('{' + 'nas_id' + '}', CGI.escape(nas_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'NasShare' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NasSharesApi#update_nas_share_by_nas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_nas_share_by_pool(pool_id, nas_share_id, nas_share_body, opts = {}) click to toggle source

Updates a specific NAS share. **API Key Scope**: nas_shares / update @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [NasShare]

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1236
def update_nas_share_by_pool(pool_id, nas_share_id, nas_share_body, opts = {})
  data, _status_code, _headers = update_nas_share_by_pool_with_http_info(pool_id, nas_share_id, nas_share_body, opts)
  data
end
update_nas_share_by_pool_with_http_info(pool_id, nas_share_id, nas_share_body, opts = {}) click to toggle source

Updates a specific NAS share. **API Key Scope**: nas_shares / update @param pool_id [String] Numeric ID, or name of pool. @param nas_share_id [String] Numeric ID or name of NAS share. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [Array<(NasShare, Integer, Hash)>] NasShare data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1248
def update_nas_share_by_pool_with_http_info(pool_id, nas_share_id, nas_share_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.update_nas_share_by_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling NasSharesApi.update_nas_share_by_pool"
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.update_nas_share_by_pool"
  end
  # verify the required parameter 'nas_share_body' is set
  if @api_client.config.client_side_validation && nas_share_body.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_body' when calling NasSharesApi.update_nas_share_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/nas_shares/{nas_share_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'NasShare' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NasSharesApi#update_nas_share_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_nas_share_with_http_info(nas_share_id, nas_share_body, opts = {}) click to toggle source

Updates a specific NAS share. **API Key Scope**: nas_shares / update @param nas_share_id [String] Numeric ID or name of NAS share. @param nas_share_body [NasShare] @param [Hash] opts the optional parameters @return [Array<(NasShare, Integer, Hash)>] NasShare data, response status code and response headers

# File lib/nodeum_sdk/api/nas_shares_api.rb, line 1100
def update_nas_share_with_http_info(nas_share_id, nas_share_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NasSharesApi.update_nas_share ...'
  end
  # verify the required parameter 'nas_share_id' is set
  if @api_client.config.client_side_validation && nas_share_id.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_id' when calling NasSharesApi.update_nas_share"
  end
  # verify the required parameter 'nas_share_body' is set
  if @api_client.config.client_side_validation && nas_share_body.nil?
    fail ArgumentError, "Missing the required parameter 'nas_share_body' when calling NasSharesApi.update_nas_share"
  end
  # resource path
  local_var_path = '/nas_shares/{nas_share_id}'.sub('{' + 'nas_share_id' + '}', CGI.escape(nas_share_id.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'NasShare' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NasSharesApi#update_nas_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end