class VSphereAutomation::Appliance::LocalAccountsApi
Attributes
Public Class Methods
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a new local user account. @param username User login name @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 24 def create(username, request_body, opts = {}) create_with_http_info(username, request_body, opts) nil end
Create a new local user account. @api private @param username User login name @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 35 def create_with_http_info(username, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalAccountsApi.create ...' end # verify the required parameter 'username' is set if @api_client.config.client_side_validation && username.nil? fail ArgumentError, "Missing the required parameter 'username' when calling LocalAccountsApi.create" end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling LocalAccountsApi.create" end # resource path local_var_path = '/appliance/local-accounts/{username}'.sub('{' + 'username' + '}', username.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(request_body) auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalAccountsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a local user account. @param username User login name @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil]
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 81 def delete(username, opts = {}) delete_with_http_info(username, opts) nil end
Delete a local user account. @api private @param username User login name @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 91 def delete_with_http_info(username, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalAccountsApi.delete ...' end # verify the required parameter 'username' is set if @api_client.config.client_side_validation && username.nil? fail ArgumentError, "Missing the required parameter 'username' when calling LocalAccountsApi.delete" end # resource path local_var_path = '/appliance/local-accounts/{username}'.sub('{' + 'username' + '}', username.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalAccountsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get the local user account information. @param username User login name @param [Hash] opts the optional parameters @return [ApplianceLocalAccountsResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|]
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 131 def get(username, opts = {}) data, _status_code, _headers = get_with_http_info(username, opts) data end
Get the local user account information. @api private @param username User login name @param [Hash] opts the optional parameters @return [Array<(ApplianceLocalAccountsResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 141 def get_with_http_info(username, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalAccountsApi.get ...' end # verify the required parameter 'username' is set if @api_client.config.client_side_validation && username.nil? fail ArgumentError, "Missing the required parameter 'username' when calling LocalAccountsApi.get" end # resource path local_var_path = '/appliance/local-accounts/{username}'.sub('{' + 'username' + '}', username.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'Appliance::ApplianceLocalAccountsResult', '400' => 'Appliance::VapiStdErrorsErrorError', '404' => 'Appliance::VapiStdErrorsNotFoundError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalAccountsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a list of the local user accounts. @param [Hash] opts the optional parameters @return [ApplianceLocalAccountsListResult|VapiStdErrorsErrorError|]
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 185 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
Get a list of the local user accounts. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceLocalAccountsListResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 194 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalAccountsApi.list ...' end # resource path local_var_path = '/appliance/local-accounts' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'Appliance::ApplianceLocalAccountsListResult', '400' => 'Appliance::VapiStdErrorsErrorError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalAccountsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Set local user account properties. @param username User login name @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil]
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 235 def set(username, request_body, opts = {}) set_with_http_info(username, request_body, opts) nil end
Set local user account properties. @api private @param username User login name @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 246 def set_with_http_info(username, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalAccountsApi.set ...' end # verify the required parameter 'username' is set if @api_client.config.client_side_validation && username.nil? fail ArgumentError, "Missing the required parameter 'username' when calling LocalAccountsApi.set" end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling LocalAccountsApi.set" end # resource path local_var_path = '/appliance/local-accounts/{username}'.sub('{' + 'username' + '}', username.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(request_body) auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalAccountsApi#set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update selected fields in local user account properties. @param username User login name @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil]
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 293 def update(username, request_body, opts = {}) update_with_http_info(username, request_body, opts) nil end
Update selected fields in local user account properties. @api private @param username User login name @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-appliance/api/local_accounts_api.rb, line 304 def update_with_http_info(username, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalAccountsApi.update ...' end # verify the required parameter 'username' is set if @api_client.config.client_side_validation && username.nil? fail ArgumentError, "Missing the required parameter 'username' when calling LocalAccountsApi.update" end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling LocalAccountsApi.update" end # resource path local_var_path = '/appliance/local-accounts/{username}'.sub('{' + 'username' + '}', username.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(request_body) auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalAccountsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end