Class: IControl::Networking::ISessionLocalInterface

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

Overview

The iSession Local interface enables you to work with the definitions and attributes contained in a device's local endpoint object.

Defined Under Namespace

Classes: NatSourceAddress, NatSourceAddressSequence

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

#allow_natEnabledState

Get the allow_nat attribute in the local 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.



55
56
57
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 55

def allow_nat
  super
end

#create(opts) ⇒ Object

Create a local WOC object.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :woc_instance (long)

    The local woc object id.

  • :local_ips (String)

    The local ip addresses.

  • :enabled (IControl::Common::EnabledState)

    The enabled flag.

  • :serverssl (String)

    The serverssl 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.



22
23
24
25
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 22

def create(opts)
  check_params(opts,[:woc_instance,:local_ips,:enabled,:serverssl])
  super
end

#delete_localObject

Delete the local WOC 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.



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

def delete_local
  super
end

#enabled_stateEnabledState

Get enable setting in the local 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.



66
67
68
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 66

def enabled_state
  super
end

#ip_listString[]

Get a list of the current WOC object names.

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.



77
78
79
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 77

def ip_list
  super
end

#listlong

Get a list of the current local endpoint object ids.

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.



88
89
90
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 88

def list
  super
end

#management_addressString

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.



99
100
101
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 99

def management_address
  super
end

#nat_source_addressNatSourceAddress

Gets the nat source address in the local 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.



110
111
112
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 110

def nat_source_address
  super
end

#serversslString

Get serverssl name strings in the local WOC object(s).

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.



121
122
123
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 121

def serverssl
  super
end

#set_allow_nat(opts) ⇒ Object

Set the allow_nat attribute in the local 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.



152
153
154
155
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 152

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

#set_enabled_state(opts) ⇒ Object

Set enable in the local 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.



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

def set_enabled_state(opts)
  check_params(opts,[:enabled_states])
  super
end

#set_management_address(opts) ⇒ Object

Set Management address

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ips (String)

    The local 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.



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

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

#set_nat_source_address(opts) ⇒ Object

Sets the nat source address in the local WOC object.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :nat_states (IControl::Networking::iSessionLocalInterface::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.



191
192
193
194
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 191

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

#set_serverssl(opts) ⇒ Object

Set serverssl string in the local WOC object.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :serverssls (String)

    The serverssl strings to be used.

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.



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

def set_serverssl(opts)
  check_params(opts,[:serverssls])
  super
end

#set_tunnel_port(opts) ⇒ Object

Set local port number in the local WOC object.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ports (long)

    The new local port numbers.

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.



217
218
219
220
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 217

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

#tunnel_portlong

Get local port number in the local WOC object.

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.



132
133
134
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 132

def tunnel_port
  super
end

#UUIDUuid_128

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.



44
45
46
# File 'lib/icontrol/networking/i_session_local_interface.rb', line 44

def UUID
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


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

def version
  super
end