Class: IControl::Management::CRLDPServer

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

Overview

The CRLDPServer interface enables you to manage CRLDP Server configuration.

Defined Under Namespace

Classes: CRLDPServerDefinition, CRLDPServerDefinitionSequence

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

#base_dn ⇒ String

Gets the base DNs of the CRLDP server.

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.



46
47
48
 
# File 'lib/icontrol/management/crldp_server.rb', line 46

def base_dn
  super
end

#create ⇒ Object

Creates this CRLDP server.

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.



15
16
17
 
# File 'lib/icontrol/management/crldp_server.rb', line 15

def create
  super
end

#delete_all_servers ⇒ Object

Deletes all CRLDP server.

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.



25
26
27
 
# File 'lib/icontrol/management/crldp_server.rb', line 25

def delete_all_servers
  super
end

#delete_server ⇒ Object

Deletes this CRLDP server.

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.



35
36
37
 
# File 'lib/icontrol/management/crldp_server.rb', line 35

def delete_server
  super
end

#hostname ⇒ String

Gets the hostnames of the CRLDP server.

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.



57
58
59
 
# File 'lib/icontrol/management/crldp_server.rb', line 57

def hostname
  super
end

#list ⇒ String

Gets a list of all CRLDP server.

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.



68
69
70
 
# File 'lib/icontrol/management/crldp_server.rb', line 68

def list
  super
end

#port ⇒ long

Gets the ports of the CRLDP server.

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.



79
80
81
 
# File 'lib/icontrol/management/crldp_server.rb', line 79

def port
  super
end

#reverse_dn_state ⇒ EnabledState

Gets the states indicating whether to match from head to tail in the case where the DNs are in reversed order.

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.



91
92
93
 
# File 'lib/icontrol/management/crldp_server.rb', line 91

def reverse_dn_state
  super
end

#set_base_dn(opts) ⇒ Object

Sets the base DNs of the CRLDP server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :base_dns (String) —

    The base DNs used by the servers.

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.



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

def set_base_dn(opts)
  opts = check_params(opts,[:base_dns])
  super(opts)
end

#set_hostname(opts) ⇒ Object

Sets the hostnames of the CRLDP server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :hostnames (String) —

    The hostnames used by the servers.

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.



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

def set_hostname(opts)
  opts = check_params(opts,[:hostnames])
  super(opts)
end

#set_port(opts) ⇒ Object

Sets the ports of the CRLDP server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ports (long) —

    The ports used by the servers.

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.



137
138
139
140
 
# File 'lib/icontrol/management/crldp_server.rb', line 137

def set_port(opts)
  opts = check_params(opts,[:ports])
  super(opts)
end

#set_reverse_dn_state(opts) ⇒ Object

Sets the states indicating whether to match from head to tail in the case where the DNs are in reversed order.

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.



151
152
153
154
 
# File 'lib/icontrol/management/crldp_server.rb', line 151

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

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


99
100
101
 
# File 'lib/icontrol/management/crldp_server.rb', line 99

def version
  super
end