Class: IControl::Networking::AdminIP

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/networking/admin_ip.rb,
lib/icontrol/networking.rb

Overview

The AdminIP interface enables you to work with the definitions and attributes contained in a device's administrative IP.

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

- (String[]) cluster_list

Gets a list of all cluster admin IPs on this cluster.

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



140
141
142
 
# File 'lib/icontrol/networking/admin_ip.rb', line 140

def cluster_list
  super
end

- (String[]) cluster_netmask(opts)

Gets the netmasks of this cluster admin IPs.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_ips (String[]) —

    The list of lists of cluster admin IPs .

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



154
155
156
157
 
# File 'lib/icontrol/networking/admin_ip.rb', line 154

def cluster_netmask(opts)
  check_params(opts,[:cluster_ips])
  super
end

- (Object) create(opts)

Creates this admin IP addresses with extended attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :admin_ips (String) —

    The list of admin IPs to create.

  • :netmasks (String) —

    The list of netmasks for the admin IPs .

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.



18
19
20
21
 
# File 'lib/icontrol/networking/admin_ip.rb', line 18

def create(opts)
  check_params(opts,[:admin_ips,:netmasks])
  super
end

- (Object) create_cluster(opts)

Creates this cluster name& IP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_ips (String[]) —

    The list of lists of cluster admin IPs to create.

  • :netmasks (String[]) —

    The list of lists of netmasks for the cluster IPs .

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



33
34
35
36
 
# File 'lib/icontrol/networking/admin_ip.rb', line 33

def create_cluster(opts)
  check_params(opts,[:cluster_ips,:netmasks])
  super
end

- (Object) create_slot_ip(opts)

Creates this admin IP addresses on the designated slots.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_name (String) —

    The cluster name.

  • :slot_ids (long)
  • :slot_ips (String[]) —

    The list of lists of slot admin IPs to create.

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



49
50
51
52
 
# File 'lib/icontrol/networking/admin_ip.rb', line 49

def create_slot_ip(opts)
  check_params(opts,[:cluster_name,:slot_ids,:slot_ips])
  super
end

- (Object) delete_administrative_ip(opts)

Deletes this admin IP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :admin_ips (String) —

    The list of admin IPs to delete.

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
65
 
# File 'lib/icontrol/networking/admin_ip.rb', line 62

def delete_administrative_ip(opts)
  check_params(opts,[:admin_ips])
  super
end

- (Object) delete_all_administrative_ips

Deletes all admin IP addresses.

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.



73
74
75
 
# File 'lib/icontrol/networking/admin_ip.rb', line 73

def delete_all_administrative_ips
  super
end

- (Object) delete_all_cluster_ips

Deletes all cluster admin IP addresses.

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



84
85
86
 
# File 'lib/icontrol/networking/admin_ip.rb', line 84

def delete_all_cluster_ips
  super
end

- (Object) delete_all_slot_ips(opts)

Deletes all admin IP addresses on the designated slots.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :slot_ids (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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



97
98
99
100
 
# File 'lib/icontrol/networking/admin_ip.rb', line 97

def delete_all_slot_ips(opts)
  check_params(opts,[:slot_ids])
  super
end

- (Object) delete_cluster_ip(opts)

Deletes this cluster admin IP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_ips (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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



111
112
113
114
 
# File 'lib/icontrol/networking/admin_ip.rb', line 111

def delete_cluster_ip(opts)
  check_params(opts,[:cluster_ips])
  super
end

- (Object) delete_slot_ip(opts)

Deletes this admin IP addresses on the designated slots.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_name (String) —

    The cluster name.

  • :slot_ids (long)
  • :slot_ips (String[]) —

    The list of list of slot admin IPs to delete.

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



127
128
129
130
 
# File 'lib/icontrol/networking/admin_ip.rb', line 127

def delete_slot_ip(opts)
  check_params(opts,[:cluster_name,:slot_ids,:slot_ips])
  super
end

- (String) list

Gets a list of all admin IPs on this device.

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.



166
167
168
 
# File 'lib/icontrol/networking/admin_ip.rb', line 166

def list
  super
end

- (String) netmask(opts)

Gets the netmasks of this admin IPs.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :admin_ips (String) —

    The list of admin IPs .

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.



179
180
181
182
 
# File 'lib/icontrol/networking/admin_ip.rb', line 179

def netmask(opts)
  check_params(opts,[:admin_ips])
  super
end

- (Object) replace_administrative_ip(opts)

Replaces this admin IP addresses with extended attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :old_ips (String) —

    The list of current admin IPs to be replaced.

  • :new_ips (String) —

    The list of new admin IPs to replace the old values.

  • :netmasks (String) —

    The list of netmasks for the admin IPs .

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



219
220
221
222
 
# File 'lib/icontrol/networking/admin_ip.rb', line 219

def replace_administrative_ip(opts)
  check_params(opts,[:old_ips,:new_ips,:netmasks])
  super
end

- (Object) replace_cluster_ip(opts)

Replaces this cluster name with new admin IP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :old_ips (String[]) —

    The list of lists of cluster admin IPs to be replaced.

  • :new_ips (String[]) —

    The list of lists of cluster admin IPs to replace the old values.

  • :netmasks (String[]) —

    The list of lists of netmasks for the cluster IPs .

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



235
236
237
238
 
# File 'lib/icontrol/networking/admin_ip.rb', line 235

def replace_cluster_ip(opts)
  check_params(opts,[:old_ips,:new_ips,:netmasks])
  super
end

- (Object) replace_slot_ip(opts)

Replaces this admin IP addresses on the designated slots.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_name (String) —

    The cluster name.

  • :slot_ids (long)
  • :old_ips (String[]) —

    The list of lists of cluster admin IPs to be replaced.

  • :new_ips (String[]) —

    The list of lists of cluster admin IPs to replace the old values.

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



252
253
254
255
 
# File 'lib/icontrol/networking/admin_ip.rb', line 252

def replace_slot_ip(opts)
  check_params(opts,[:cluster_name,:slot_ids,:old_ips,:new_ips])
  super
end

- (Object) set_cluster_netmask(opts)

Sets the netmasks of this cluster admin IPs.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_ips (String[]) —

    The list of lists of cluster admin IPs .

  • :netmasks (String[]) —

    The list of lists of netmasks for the cluster IPs .

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



267
268
269
270
 
# File 'lib/icontrol/networking/admin_ip.rb', line 267

def set_cluster_netmask(opts)
  check_params(opts,[:cluster_ips,:netmasks])
  super
end

- (Object) set_netmask(opts)

Sets the netmasks of this admin IPs.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :admin_ips (String) —

    The list of admin IPs .

  • :netmasks (String) —

    The list of netmasks of the specified admin IPs .

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.



281
282
283
284
 
# File 'lib/icontrol/networking/admin_ip.rb', line 281

def set_netmask(opts)
  check_params(opts,[:admin_ips,:netmasks])
  super
end

- (String[]) slot_ip(opts)

Gets a list of all admin IPs on the designated slots.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cluster_name (String) —

    The cluster name.

  • :slot_ids (long)

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.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



195
196
197
198
 
# File 'lib/icontrol/networking/admin_ip.rb', line 195

def slot_ip(opts)
  check_params(opts,[:cluster_name,:slot_ids])
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


204
205
206
 
# File 'lib/icontrol/networking/admin_ip.rb', line 204

def version
  super
end