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

- (DataCenterStatistics) all_statistics

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

- (String) contact_information

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

- (Object) create

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

- (Object) delete_all_data_centers

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

- (Object) delete_data_center

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

- (EnabledState) enabled_state

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

- (DataCenterLinkDefinition) link

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

- (String) list

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

- (String) location_information

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

- (ObjectStatus) object_status

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

- (Object) reset_statistics

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

- (DataCenterServerDefinition) server

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

- (Object) set_contact_information(opts)

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)
  check_params(opts,[:contacts])
  super
end

- (Object) set_enabled_state(opts)

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)
  check_params(opts,[:states])
  super
end

- (Object) set_location_information(opts)

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)
  check_params(opts,[:locations])
  super
end

- (DataCenterStatistics) statistics

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

- (String) version

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