Class: IControl::LocalLB::ProfileFTP

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/local_lb/profile_ftp.rb,
lib/icontrol/local_lb.rb

Overview

The ProfileFTP interface enables you to manipulate a local load balancer's FTP profile.

Defined Under Namespace

Classes: ProfileFTPStatisticEntry, ProfileFTPStatisticEntrySequence, ProfileFTPStatistics

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

#all_statisticsProfileFTPStatistics

Gets the statistics for all the FTP profile.

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.



47
48
49
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 47

def all_statistics
  super
end

#createObject

Creates this FTP profile.

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
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 16

def create
  super
end

#data_channel_portProfilePortNumber

Gets the data channel port for this FTP profile.

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.



58
59
60
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 58

def data_channel_port
  super
end

#default_profileString

Gets the names of the default profile from which this profile will derive default values for its attributes.

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.



70
71
72
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 70

def default_profile
  super
end

#delete_all_profilesObject

Deletes all FTP profile.

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.



26
27
28
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 26

def delete_all_profiles
  super
end

#delete_profileObject

Deletes this FTP profile.

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/local_lb/profile_ftp.rb', line 36

def delete_profile
  super
end

#is_base_profileboolean

Determines whether this profile are base/pre-configured profile, or user-defined profile.

Returns:

  • (boolean)

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.



135
136
137
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 135

def is_base_profile
  super
end

#listString

Gets a list of all FTP profile.

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.



81
82
83
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 81

def list
  super
end

#reset_statisticsObject

Resets the statistics for this FTP profile.

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/local_lb/profile_ftp.rb', line 145

def reset_statistics
  super
end

#security_enabled_request_stateProfileEnabledState

Gets the state that if true, enable horizontal security for this FTP profile.

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.



92
93
94
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 92

def security_enabled_request_state
  super
end

#set_data_channel_port(opts) ⇒ Object

Sets the data channel port for this FTP profile.

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.



157
158
159
160
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 157

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

#set_default_profile(opts) ⇒ Object

Sets the names of the default profile from which this profile will derive default values for its attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String)

    The default profiles from which the specified profiles will get default 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.



171
172
173
174
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 171

def set_default_profile(opts)
  opts = check_params(opts,[:defaults])
  super(opts)
end

#set_security_enabled_request_state(opts) ⇒ Object

Sets the state that if true, enable horizontal security for this FTP profile.

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.



184
185
186
187
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 184

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

#set_translated_extended_request_state(opts) ⇒ Object

Sets the state that if true, automatically translate RFC2428 extended requests EPSV and EPRT to PASV and PORT when talking to IPv4 servers.

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.



198
199
200
201
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 198

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

#statisticsProfileFTPStatistics

Gets the statistics for this FTP profile.

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.



103
104
105
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 103

def statistics
  super
end

#translated_extended_request_stateProfileEnabledState

Gets the state that if true, automatically translate RFC2428 extended requests EPSV and EPRT to PASV and PORT when talking to IPv4 servers.

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.



115
116
117
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 115

def translated_extended_request_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


123
124
125
# File 'lib/icontrol/local_lb/profile_ftp.rb', line 123

def version
  super
end