RubyGems - vsphere-automation-appliance - Versions diffs - 0.4.2 → 0.4.7 - Mend

vsphere-automation-appliance 0.4.2 → 0.4.7

Files changed (750) hide show

data/docs/VapiStdErrorsUnauthorized.md DELETED

@@ -1,9 +0,0 @@
-# VSphereAutomation::Appliance::VapiStdErrorsUnauthorized
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messages** | [**Array&lt;VapiStdLocalizableMessage&gt;**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. &lt;p&gt; The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \&quot;cause\&quot; of the prior message. |
-**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. &lt;p&gt; {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional]

data/docs/VapiStdErrorsUnauthorizedError.md DELETED

@@ -1,9 +0,0 @@
-# VSphereAutomation::Appliance::VapiStdErrorsUnauthorizedError
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** |  | [optional]
-**value** | [**VapiStdErrorsUnauthorized**](VapiStdErrorsUnauthorized.md) |  | [optional]

data/docs/VapiStdLocalizableMessage.md DELETED

@@ -1,10 +0,0 @@
-# VSphereAutomation::Appliance::VapiStdLocalizableMessage
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique identifier of the localizable string or message template. &lt;p&gt; This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
-**default_message** | **String** | The value of this localizable string or message template in the {@code en_US} (English) locale.  If {@link #id} refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user.  It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
-**args** | **Array&lt;String&gt;** | Arguments to be substituted into a message template. |

data/docs/VmonServiceApi.md DELETED

@@ -1,308 +0,0 @@
-# VSphereAutomation::Appliance::VmonServiceApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](VmonServiceApi.md#get) | **GET** /appliance/vmon/service/{service} | Returns the state of a service.
-[**list_details**](VmonServiceApi.md#list_details) | **GET** /appliance/vmon/service | Lists details of services managed by vMon.
-[**restart**](VmonServiceApi.md#restart) | **POST** /appliance/vmon/service/{service}/restart | Restarts a service
-[**start**](VmonServiceApi.md#start) | **POST** /appliance/vmon/service/{service}/start | Starts a service
-[**stop**](VmonServiceApi.md#stop) | **POST** /appliance/vmon/service/{service}/stop | Stops a service
-[**update**](VmonServiceApi.md#update) | **PATCH** /appliance/vmon/service/{service} | Updates the properties of a service.
-# **get**
-> ApplianceVmonServiceResult get(service)
-Returns the state of a service.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-appliance'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::Appliance::VmonServiceApi.new
-service = 'service_example' # String | identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: appliance.vmon.Service.
-begin
-  #Returns the state of a service.
-  result = api_instance.get(service)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling VmonServiceApi->get: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service** | **String**| identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: appliance.vmon.Service. |
-### Return type
-[**ApplianceVmonServiceResult**](ApplianceVmonServiceResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **list_details**
-> ApplianceVmonServiceListDetailsResult list_details
-Lists details of services managed by vMon.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-appliance'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::Appliance::VmonServiceApi.new
-begin
-  #Lists details of services managed by vMon.
-  result = api_instance.list_details
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling VmonServiceApi->list_details: #{e}"
-end
-```
-### Parameters
-This endpoint does not need any parameter.
-### Return type
-[**ApplianceVmonServiceListDetailsResult**](ApplianceVmonServiceListDetailsResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **restart**
-> restart(service)
-Restarts a service
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-appliance'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::Appliance::VmonServiceApi.new
-service = 'service_example' # String | identifier of the service to restart The parameter must be an identifier for the resource type: appliance.vmon.Service.
-begin
-  #Restarts a service
-  api_instance.restart(service)
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling VmonServiceApi->restart: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service** | **String**| identifier of the service to restart The parameter must be an identifier for the resource type: appliance.vmon.Service. |
-### Return type
-nil (empty response body)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **start**
-> start(service)
-Starts a service
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-appliance'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::Appliance::VmonServiceApi.new
-service = 'service_example' # String | identifier of the service to start The parameter must be an identifier for the resource type: appliance.vmon.Service.
-begin
-  #Starts a service
-  api_instance.start(service)
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling VmonServiceApi->start: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service** | **String**| identifier of the service to start The parameter must be an identifier for the resource type: appliance.vmon.Service. |
-### Return type
-nil (empty response body)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **stop**
-> stop(service)
-Stops a service
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-appliance'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::Appliance::VmonServiceApi.new
-service = 'service_example' # String | identifier of the service to stop The parameter must be an identifier for the resource type: appliance.vmon.Service.
-begin
-  #Stops a service
-  api_instance.stop(service)
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling VmonServiceApi->stop: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service** | **String**| identifier of the service to stop The parameter must be an identifier for the resource type: appliance.vmon.Service. |
-### Return type
-nil (empty response body)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **update**
-> update(service, request_body)
-Updates the properties of a service.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-appliance'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::Appliance::VmonServiceApi.new
-service = 'service_example' # String | identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: appliance.vmon.Service.
-request_body = Appliance::ApplianceVmonServiceUpdate.new # ApplianceVmonServiceUpdate |
-begin
-  #Updates the properties of a service.
-  api_instance.update(service, request_body)
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling VmonServiceApi->update: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service** | **String**| identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: appliance.vmon.Service. |
- **request_body** | [**ApplianceVmonServiceUpdate**](ApplianceVmonServiceUpdate.md)|  |
-### Return type
-nil (empty response body)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json

data/git_push.sh DELETED

@@ -1,55 +0,0 @@
-#!/bin/sh
-#
-# Generated by: https://openapi-generator.tech
-#
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-# Initialize the local directory as a Git repository
-git init
-# Adds the files in the local repository and stages them for commit.
-git add .
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-# Sets the new remote
-git_remote=`git remote`
-if [ "$git_remote" = "" ]; then # git remote not defined
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
-    fi
-fi
-git pull origin master
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

data/spec/api/access_consolecli_api_spec.rb DELETED

@@ -1,52 +0,0 @@
-# Copyright (c) 2018-2019 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
-# appliance - The vCenter Server Appliance is a preconfigured Linux-based virtual machine optimized for running vCenter Server and associated services.
-require 'spec_helper'
-require 'json'
-# Unit tests for VSphereAutomation::Appliance::AccessConsolecliApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'AccessConsolecliApi' do
-  before do
-    # run before each test
-    @instance = VSphereAutomation::Appliance::AccessConsolecliApi.new
-  end
-  after do
-    # run after each test
-  end
-  describe 'test an instance of AccessConsolecliApi' do
-    it 'should create an instance of AccessConsolecliApi' do
-      expect(@instance).to be_instance_of(VSphereAutomation::Appliance::AccessConsolecliApi)
-    end
-  end
-  # unit tests for get
-  # Get enabled state of the console-based controlled CLI (TTY1).
-  # @param [Hash] opts the optional parameters
-  # @return [ApplianceAccessConsolecliResult]
-  describe 'get test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-  # unit tests for set
-  # Set enabled state of the console-based controlled CLI (TTY1).
-  # @param request_body
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'set test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-end