Class: IControl::Management::CRLDPConfiguration

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

Overview

The CRLDPConfiguration interface enables you to manage CRLDP PAM configuration.

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

#add_server(opts) ⇒ Object

Adds/associates servers to this CRLDP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to add to the CRLDP configurations.

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.



16
17
18
19
# File 'lib/icontrol/management/crldp_configuration.rb', line 16

def add_server(opts)
  opts = check_params(opts,[:servers])
  super(opts)
end

#cache_timeoutlong

Gets the number of seconds before a CRL entry expires and is deleted from the CRL cache.

Returns:

  • (long)

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.



62
63
64
# File 'lib/icontrol/management/crldp_configuration.rb', line 62

def cache_timeout
  super
end

#connection_timeoutlong

Gets the number of seconds to wait for server's response before concluding that the server is down.

Returns:

  • (long)

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.



74
75
76
# File 'lib/icontrol/management/crldp_configuration.rb', line 74

def connection_timeout
  super
end

#create(opts) ⇒ Object

Creates this CRLDP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The list of servers to be assigned to each of the configurations.

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.



29
30
31
32
# File 'lib/icontrol/management/crldp_configuration.rb', line 29

def create(opts)
  opts = check_params(opts,[:servers])
  super(opts)
end

#delete_all_configurationsObject

Deletes all CRLDP configurations.

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.



40
41
42
# File 'lib/icontrol/management/crldp_configuration.rb', line 40

def delete_all_configurations
  super
end

#delete_configurationObject

Deletes this CRLDP configurations.

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/crldp_configuration.rb', line 50

def delete_configuration
  super
end

#listString

Gets a list of all CRLDP configurations.

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.



85
86
87
# File 'lib/icontrol/management/crldp_configuration.rb', line 85

def list
  super
end

#remove_all_serversObject

Removes all servers from this CRLDP configurations.

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.



136
137
138
# File 'lib/icontrol/management/crldp_configuration.rb', line 136

def remove_all_servers
  super
end

#remove_server(opts) ⇒ Object

Removes servers from this CRLDP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to remove from the CRLDP configurations.

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.



148
149
150
151
# File 'lib/icontrol/management/crldp_configuration.rb', line 148

def remove_server(opts)
  opts = check_params(opts,[:servers])
  super(opts)
end

#serverString[]

Gets the lists of servers this CRLDP configurations are associated with.

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.



96
97
98
# File 'lib/icontrol/management/crldp_configuration.rb', line 96

def server
  super
end

#set_cache_timeout(opts) ⇒ Object

Sets the number of seconds before a CRL entry expires and is deleted from the CRL cache.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :timeouts (long)

    The timeouts used by the configurations.

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.



162
163
164
165
# File 'lib/icontrol/management/crldp_configuration.rb', line 162

def set_cache_timeout(opts)
  opts = check_params(opts,[:timeouts])
  super(opts)
end

#set_connection_timeout(opts) ⇒ Object

Sets the number of seconds to wait for server's response before concluding that the server is down.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :timeouts (long)

    The connection timeouts used by the configurations.

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.



176
177
178
179
# File 'lib/icontrol/management/crldp_configuration.rb', line 176

def set_connection_timeout(opts)
  opts = check_params(opts,[:timeouts])
  super(opts)
end

#set_update_interval(opts) ⇒ Object

Sets the number of seconds to wait between updates.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :intervals (long)

    The update intervals used by the configurations.

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.



189
190
191
192
# File 'lib/icontrol/management/crldp_configuration.rb', line 189

def set_update_interval(opts)
  opts = check_params(opts,[:intervals])
  super(opts)
end

#set_use_issuer_state(opts) ⇒ Object

Sets the states indicating whether to reuse the issuer.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



202
203
204
205
# File 'lib/icontrol/management/crldp_configuration.rb', line 202

def set_use_issuer_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#update_intervallong

Gets the number of seconds to wait between updates.

Returns:

  • (long)

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.



107
108
109
# File 'lib/icontrol/management/crldp_configuration.rb', line 107

def update_interval
  super
end

#use_issuer_stateEnabledState

Gets the states indicating whether reuse the issuer.

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.



118
119
120
# File 'lib/icontrol/management/crldp_configuration.rb', line 118

def use_issuer_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


126
127
128
# File 'lib/icontrol/management/crldp_configuration.rb', line 126

def version
  super
end