Class: IControl::GlobalLB::DataCenter

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/global_lb/data_center.rb,
lib/icontrol/global_lb.rb

Overview

The DataCenter interface enables you to manipulate the data center attributes for a Global TM. For example, use the DataCenter interface to add or remove a data center, transfer server assignments from one data center to another, get and set data center attributes, remove a server from a data center, and so on.

Defined Under Namespace

Classes: DataCenterAttribute, DataCenterAttributeSequence, DataCenterLinkDefinition, DataCenterLinkSequence, DataCenterServerDefinition, DataCenterServerSequence, DataCenterStatisticEntry, DataCenterStatisticEntrySequence, DataCenterStatistics

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_statisticsDataCenterStatistics

Gets the statistics for all the data center.

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.


56
57
58
# File 'lib/icontrol/global_lb/data_center.rb', line 56

def all_statistics
  super
end

#contact_informationString

Gets contact information for this data center.

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.


67
68
69
# File 'lib/icontrol/global_lb/data_center.rb', line 67

def contact_information
  super
end

#createObject

Creates this data center.

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/global_lb/data_center.rb', line 25

def create
  super
end

#delete_all_data_centersObject

Deletes all data center.

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/global_lb/data_center.rb', line 35

def delete_all_data_centers
  super
end

#delete_data_centerObject

Deletes this data center.

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.


45
46
47
# File 'lib/icontrol/global_lb/data_center.rb', line 45

def delete_data_center
  super
end

#enabled_stateEnabledState

Gets the enabled state of this data center.

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.


78
79
80
# File 'lib/icontrol/global_lb/data_center.rb', line 78

def enabled_state
  super
end

Gets a list of links of this data center.

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.


89
90
91
# File 'lib/icontrol/global_lb/data_center.rb', line 89

def link
  super
end

#listString

Gets a list of data center.

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.


100
101
102
# File 'lib/icontrol/global_lb/data_center.rb', line 100

def list
  super
end

#location_informationString

Gets location information for this data center.

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.


111
112
113
# File 'lib/icontrol/global_lb/data_center.rb', line 111

def location_information
  super
end

#object_statusObjectStatus

Gets the statuses of this data center.

Returns:

  • (ObjectStatus)

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.


122
123
124
# File 'lib/icontrol/global_lb/data_center.rb', line 122

def object_status
  super
end

#reset_statisticsObject

Resets the statistics for this data center.

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.


162
163
164
# File 'lib/icontrol/global_lb/data_center.rb', line 162

def reset_statistics
  super
end

#serverDataCenterServerDefinition

Gets a list of servers of this data center.

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.


133
134
135
# File 'lib/icontrol/global_lb/data_center.rb', line 133

def server
  super
end

#set_contact_information(opts) ⇒ Object

Sets contact information for this data center.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :contacts (String)

    The contact information.

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.


174
175
176
177
# File 'lib/icontrol/global_lb/data_center.rb', line 174

def set_contact_information(opts)
  opts = check_params(opts,[:contacts])
  super(opts)
end

#set_enabled_state(opts) ⇒ Object

Sets the enabled state of this data center.

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.


187
188
189
190
# File 'lib/icontrol/global_lb/data_center.rb', line 187

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

#set_location_information(opts) ⇒ Object

Sets location information for this data center.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :locations (String)

    The location information.

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.


200
201
202
203
# File 'lib/icontrol/global_lb/data_center.rb', line 200

def set_location_information(opts)
  opts = check_params(opts,[:locations])
  super(opts)
end

#statisticsDataCenterStatistics

Gets the statistics for this data center.

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.


144
145
146
# File 'lib/icontrol/global_lb/data_center.rb', line 144

def statistics
  super
end

#versionString

Get the version information for this interface.

Returns:

  • (String)

152
153
154
# File 'lib/icontrol/global_lb/data_center.rb', line 152

def version
  super
end