Class: IControl::Management::LicenseAdministration

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/management/license_administration.rb,
lib/icontrol/management.rb

Overview

The LicenseAdministration interface exposes methods that enable you to authorize the system, either manually or in an automated fashion. This interface allows you to generate license files, install previously generated licenses, and view other licensing characteristics.

Defined Under Namespace

Classes: EvaluationExpiration, ModuleExpiry, ModuleExpirySequence, ModuleKey, ModuleKeySequence, ModuleKeyTimeLimits, TimeLimitedModuleKey, TimeLimitedModuleKeySequence

Instance Method Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

- (boolean) check_registration_key_crc(opts)

Checks to see if this registration keys will pass the CRC validation.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :registration_keys (String) —

    The list of registration keys to do a CRC check.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



27
28
29
30
 
# File 'lib/icontrol/management/license_administration.rb', line 27

def check_registration_key_crc(opts)
  check_params(opts,[:registration_keys])
  super
end

- (char) copyright_file

Retrieves the copyright file.

Returns:

  • (char)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



39
40
41
 
# File 'lib/icontrol/management/license_administration.rb', line 39

def copyright_file
  super
end

- (char) eula_file

Retrieves the EULA agreement file.

Returns:

  • (char)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



50
51
52
 
# File 'lib/icontrol/management/license_administration.rb', line 50

def eula_file
  super
end

- (EvaluationExpiration) evaluation_license_expiration

Gets information on when the evaluation license will expire.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



61
62
63
 
# File 'lib/icontrol/management/license_administration.rb', line 61

def evaluation_license_expiration
  super
end

- (Object) install_license(opts)

Installs and authorizes the device using this stream of license file data.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :license_file_data (char) —

    The license file data.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



187
188
189
190
 
# File 'lib/icontrol/management/license_administration.rb', line 187

def install_license(opts)
  check_params(opts,[:license_file_data])
  super
end

- (Object) install_license_from_file(opts)

Installs and authorizes the device using this license file somewhere on the device.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :license_file (String) —

    The license file location.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



200
201
202
203
 
# File 'lib/icontrol/management/license_administration.rb', line 200

def install_license_from_file(opts)
  check_params(opts,[:license_file])
  super
end

- (boolean) is_evaluation_license

Checks to see whether the device is running with an evaluation license.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



212
213
214
 
# File 'lib/icontrol/management/license_administration.rb', line 212

def is_evaluation_license
  super
end

- (EnabledState) license_activation_status

Checks to see whether the device has been licensed.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



72
73
74
 
# File 'lib/icontrol/management/license_administration.rb', line 72

def license_activation_status
  super
end

- (char) license_file

Retrieves the active license file.

Returns:

  • (char)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



83
84
85
 
# File 'lib/icontrol/management/license_administration.rb', line 83

def license_file
  super
end

- (EnabledState) module_enabled_state

Gets information indicating whether the given module are enabled in the license. Caution! This enabled state is what is specified in the license for the module without regard for whether the module is provisionable or provisioned under this hardware and configuration. See the Provision interface.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



97
98
99
 
# File 'lib/icontrol/management/license_administration.rb', line 97

def module_enabled_state
  super
end

- (ModuleExpiry) module_expiry

Gets information about expiry of the given module. Caution! The expiry information does not indicate whether a module is provisionable or provisioned. See the Provision interface. Note: This returns the enabled state as well. When getting the module expiry information, we suggest making use of the enabled state returned here rather than getting enabled state separately.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



112
113
114
 
# File 'lib/icontrol/management/license_administration.rb', line 112

def module_expiry
  super
end

- (ModuleKey) module_keys

Gets the module keys used to license the device, including descriptive information about them. You will get active and inactive keys (and the record has a field describing whether it is active). See also get_time_limited_module_keys.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



125
126
127
 
# File 'lib/icontrol/management/license_administration.rb', line 125

def module_keys
  super
end

- (String) registration_keys

Gets the list of registration keys used to license the device. This returns the base key first, then add-on keys. As of v10.0.0, there are new add-on keys that are time limited; with this method you can tell they are there but not when they expire. If that matters, you should use the newer method get_time_limited_module_keys. All of the keys returned are active keys.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



140
141
142
 
# File 'lib/icontrol/management/license_administration.rb', line 140

def registration_keys
  super
end

- (String) system_dossier(opts)

Gets the kernel dossier based on this registration keys.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :registration_keys (String) —

    The list of registration keys used to get the kernel dossier.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



153
154
155
156
 
# File 'lib/icontrol/management/license_administration.rb', line 153

def system_dossier(opts)
  check_params(opts,[:registration_keys])
  super
end

- (TimeLimitedModuleKey) time_limited_module_keys

Gets the time limited module keys used to license the device, including descriptive information about them. You will get active and inactive keys (and the record has a field describing whether it is active).

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



167
168
169
 
# File 'lib/icontrol/management/license_administration.rb', line 167

def time_limited_module_keys
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


175
176
177
 
# File 'lib/icontrol/management/license_administration.rb', line 175

def version
  super
end