Class: IControl::Networking::ISessionRemoteInterface

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

Overview

The iSession RemoteInterface interface enables you to work with the definitions and attributes contained in a device's peer iSession Remote Endpoint objects.

Defined Under Namespace

Classes: NatSourceAddress, NatSourceAddressSequence, OriginState, OriginStateSequence

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

- (EnabledState) behind_nat

Get the nat attribute from the peer WOC object.

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.



68
69
70
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 68

def behind_nat
  super
end

- (Object) create(opts)

Create a peer Remote Endpoint object.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :peer_names (String) —

    The peer names.

  • :serverssls (String) —

    The serverssl identifiers.

  • :peer_ips (String) —

    The peer mgmt ips.

  • :enabled_states (IControl::Common::EnabledState) —

    The is enable states settings.

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
28
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 25

def create(opts)
  check_params(opts,[:peer_names,:serverssls,:peer_ips,:enabled_states])
  super
end

- (long) dedup_cache

Get dedup_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.



79
80
81
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 79

def dedup_cache
  super
end

- (Object) delete_all_peers

Deletes all peer remote endpoint objects.

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.



36
37
38
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 36

def delete_all_peers
  super
end

- (Object) delete_peer

Delete the peer Remote Endpoint object.

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/networking/i_session_remote_interface.rb', line 46

def delete_peer
  super
end

- (String) list

Get a list of the current iSession peer objects.

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.



90
91
92
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 90

def list
  super
end

- (String) management_address

Get Management address

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.



101
102
103
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 101

def management_address
  super
end

- (String) nat_config_status

Get config_status

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.



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

def nat_config_status
  super
end

- (NatSourceAddress) nat_source_address

Get the nat address attribute in the peer WOC object.

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.



123
124
125
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 123

def nat_source_address
  super
end

- (OriginState) origin

Get origin

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.



134
135
136
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 134

def origin
  super
end

- (EnabledState) peer_enabled_state

Get enable setting in the peer object.

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.



145
146
147
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 145

def peer_enabled_state
  super
end

- (String[]) peer_ip_list

Get a list of the current iSession peer object 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.



156
157
158
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 156

def peer_ip_list
  super
end

- (EnabledState) peer_routing_state

Get enabled flag in the peer routing attribute.

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.



167
168
169
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 167

def peer_routing_state
  super
end

- (String) profile_serverssl

Get serverssl

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.



178
179
180
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 178

def profile_serverssl
  super
end

- (Object) set_behind_nat(opts)

Set the nat attribute in the peer WOC object.

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.



209
210
211
212
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 209

def set_behind_nat(opts)
  check_params(opts,[:nat_states])
  super
end

- (Object) set_management_address(opts)

Set Management address

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ips (String) —

    The new mgmt addresses to use.

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.



222
223
224
225
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 222

def set_management_address(opts)
  check_params(opts,[:ips])
  super
end

- (Object) set_nat_config_status(opts)

Set config_status

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :nat_configs (String) —

    The new nat configs.

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.



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

def set_nat_config_status(opts)
  check_params(opts,[:nat_configs])
  super
end

- (Object) set_nat_source_address(opts)

Set the nat address attribute in the peer WOC object.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :nat_states (IControl::Networking::iSessionRemoteInterface::NatSourceAddress) —

    The new nat states.

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.



248
249
250
251
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 248

def set_nat_source_address(opts)
  check_params(opts,[:nat_states])
  super
end

- (Object) set_origin(opts)

Set origin

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :origins (IControl::Networking::iSessionRemoteInterface::OriginState) —

    The new peer origin states.

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.



261
262
263
264
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 261

def set_origin(opts)
  check_params(opts,[:origins])
  super
end

- (Object) set_peer_enabled_state(opts)

Set enable in the peer object.

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.



274
275
276
277
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 274

def set_peer_enabled_state(opts)
  check_params(opts,[:enabled])
  super
end

- (Object) set_peer_routing_state(opts)

Set enabled flag in the peer routing attribute.

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.



287
288
289
290
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 287

def set_peer_routing_state(opts)
  check_params(opts,[:routing])
  super
end

- (Object) set_profile_serverssl(opts)

Set serverssl

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :serverssl (String) —

    The server ssl name.

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.



300
301
302
303
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 300

def set_profile_serverssl(opts)
  check_params(opts,[:serverssl])
  super
end

- (Object) set_tunnel_port(opts)

Set tunnel_port

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :tunnel_ports (short) —

    The tunnel port number.

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.



313
314
315
316
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 313

def set_tunnel_port(opts)
  check_params(opts,[:tunnel_ports])
  super
end

- (short) tunnel_port

Get tunnel_port

Returns:

  • (short)

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
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 189

def tunnel_port
  super
end

- (Uuid_128) UUID

Get UUID

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.



57
58
59
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 57

def UUID
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


197
198
199
 
# File 'lib/icontrol/networking/i_session_remote_interface.rb', line 197

def version
  super
end