icontrol 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/lib/icontrol/arx.rb +38 -8
- data/lib/icontrol/arx/api.rb +1 -0
- data/lib/icontrol/arx/chassis.rb +11 -0
- data/lib/icontrol/arx/export.rb +4 -1
- data/lib/icontrol/arx/file_change_notification.rb +25 -4
- data/lib/icontrol/arx/file_server.rb +2 -0
- data/lib/icontrol/arx/namespace.rb +2 -0
- data/lib/icontrol/arx/network.rb +3 -0
- data/lib/icontrol/arx/policy.rb +3 -0
- data/lib/icontrol/arx/share.rb +2 -0
- data/lib/icontrol/arx/virtual_service.rb +3 -0
- data/lib/icontrol/arx/volume.rb +2 -0
- data/lib/icontrol/asm.rb +18 -3
- data/lib/icontrol/asm/object_params.rb +12 -6
- data/lib/icontrol/asm/policy.rb +118 -79
- data/lib/icontrol/asm/system_configuration.rb +27 -19
- data/lib/icontrol/asm/web_application.rb +74 -52
- data/lib/icontrol/asm/web_application_group.rb +33 -24
- data/lib/icontrol/base.rb +1 -0
- data/lib/icontrol/base/exception.rb +1 -0
- data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
- data/lib/icontrol/base/icontrol_overlay.rb +6 -0
- data/lib/icontrol/base/predeclarations.rb +5 -4
- data/lib/icontrol/base/struct.rb +6 -2
- data/lib/icontrol/common.rb +55 -4
- data/lib/icontrol/global_lb.rb +22 -3
- data/lib/icontrol/global_lb/application.rb +63 -44
- data/lib/icontrol/global_lb/data_center.rb +82 -58
- data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
- data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
- data/lib/icontrol/global_lb/globals.rb +662 -430
- data/lib/icontrol/global_lb/link.rb +181 -131
- data/lib/icontrol/global_lb/monitor.rb +174 -104
- data/lib/icontrol/global_lb/pool.rb +290 -203
- data/lib/icontrol/global_lb/pool_member.rb +118 -71
- data/lib/icontrol/global_lb/region.rb +37 -25
- data/lib/icontrol/global_lb/rule.rb +53 -37
- data/lib/icontrol/global_lb/server.rb +176 -124
- data/lib/icontrol/global_lb/topology.rb +41 -27
- data/lib/icontrol/global_lb/virtual_server.rb +118 -84
- data/lib/icontrol/global_lb/wide_ip.rb +168 -117
- data/lib/icontrol/local_lb.rb +81 -10
- data/lib/icontrol/local_lb/klass.rb +233 -153
- data/lib/icontrol/local_lb/monitor.rb +158 -96
- data/lib/icontrol/local_lb/nat.rb +74 -52
- data/lib/icontrol/local_lb/node_address.rb +123 -86
- data/lib/icontrol/local_lb/pool.rb +229 -164
- data/lib/icontrol/local_lb/pool_member.rb +134 -76
- data/lib/icontrol/local_lb/profile_auth.rb +103 -75
- data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
- data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
- data/lib/icontrol/local_lb/profile_dns.rb +65 -46
- data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
- data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
- data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
- data/lib/icontrol/local_lb/profile_http.rb +701 -433
- data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
- data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
- data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
- data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
- data/lib/icontrol/local_lb/profile_radius.rb +94 -62
- data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
- data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
- data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
- data/lib/icontrol/local_lb/profile_sip.rb +145 -99
- data/lib/icontrol/local_lb/profile_stream.rb +71 -51
- data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
- data/lib/icontrol/local_lb/profile_udp.rb +109 -78
- data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
- data/lib/icontrol/local_lb/profile_xml.rb +116 -79
- data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
- data/lib/icontrol/local_lb/rate_class.rb +523 -318
- data/lib/icontrol/local_lb/rule.rb +53 -37
- data/lib/icontrol/local_lb/snat.rb +96 -65
- data/lib/icontrol/local_lb/snat_pool.rb +54 -39
- data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
- data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
- data/lib/icontrol/local_lb/virtual_address.rb +99 -70
- data/lib/icontrol/local_lb/virtual_server.rb +358 -243
- data/lib/icontrol/lt_config.rb +8 -1
- data/lib/icontrol/lt_config/field.rb +87 -53
- data/lib/icontrol/lt_config/klass.rb +59 -43
- data/lib/icontrol/management.rb +80 -38
- data/lib/icontrol/management/ccldap_configuration.rb +218 -144
- data/lib/icontrol/management/change_control.rb +67 -41
- data/lib/icontrol/management/crldp_configuration.rb +73 -52
- data/lib/icontrol/management/crldp_server.rb +55 -39
- data/lib/icontrol/management/db_variable.rb +32 -21
- data/lib/icontrol/management/event_notification.rb +19 -8
- data/lib/icontrol/management/event_subscription.rb +121 -74
- data/lib/icontrol/management/key_certificate.rb +235 -138
- data/lib/icontrol/management/ldap_configuration.rb +249 -179
- data/lib/icontrol/management/license_administration.rb +97 -56
- data/lib/icontrol/management/named.rb +103 -67
- data/lib/icontrol/management/ocsp_configuration.rb +33 -24
- data/lib/icontrol/management/ocsp_responder.rb +294 -165
- data/lib/icontrol/management/partition.rb +42 -23
- data/lib/icontrol/management/provision.rb +73 -39
- data/lib/icontrol/management/radius_configuration.rb +85 -57
- data/lib/icontrol/management/radius_server.rb +51 -37
- data/lib/icontrol/management/resource_record.rb +163 -121
- data/lib/icontrol/management/snmp_configuration.rb +675 -390
- data/lib/icontrol/management/tacacs_configuration.rb +99 -67
- data/lib/icontrol/management/tmos_module.rb +20 -8
- data/lib/icontrol/management/user_management.rb +198 -124
- data/lib/icontrol/management/view.rb +33 -24
- data/lib/icontrol/management/zone.rb +49 -34
- data/lib/icontrol/management/zone_runner.rb +11 -7
- data/lib/icontrol/networking.rb +31 -4
- data/lib/icontrol/networking/admin_ip.rb +92 -71
- data/lib/icontrol/networking/arp.rb +41 -28
- data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
- data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
- data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
- data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
- data/lib/icontrol/networking/interfaces.rb +241 -142
- data/lib/icontrol/networking/packet_filter.rb +111 -69
- data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
- data/lib/icontrol/networking/port_mirror.rb +39 -27
- data/lib/icontrol/networking/profile_gre.rb +63 -41
- data/lib/icontrol/networking/profile_ipip.rb +38 -25
- data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
- data/lib/icontrol/networking/route_domain.rb +70 -44
- data/lib/icontrol/networking/route_table.rb +128 -91
- data/lib/icontrol/networking/self_ip.rb +57 -39
- data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
- data/lib/icontrol/networking/stp_globals.rb +115 -63
- data/lib/icontrol/networking/stp_instance.rb +166 -68
- data/lib/icontrol/networking/trunk.rb +165 -101
- data/lib/icontrol/networking/tunnel.rb +77 -52
- data/lib/icontrol/networking/vlan.rb +140 -98
- data/lib/icontrol/networking/vlan_group.rb +145 -101
- data/lib/icontrol/system.rb +70 -33
- data/lib/icontrol/system/cluster.rb +103 -81
- data/lib/icontrol/system/config_sync.rb +128 -72
- data/lib/icontrol/system/connections.rb +27 -17
- data/lib/icontrol/system/disk.rb +134 -67
- data/lib/icontrol/system/failover.rb +44 -27
- data/lib/icontrol/system/geo_ip.rb +16 -5
- data/lib/icontrol/system/inet.rb +47 -30
- data/lib/icontrol/system/internal.rb +13 -9
- data/lib/icontrol/system/services.rb +75 -42
- data/lib/icontrol/system/software_management.rb +132 -83
- data/lib/icontrol/system/statistics.rb +443 -298
- data/lib/icontrol/system/system_info.rb +137 -95
- data/lib/icontrol/web_accelerator/applications.rb +17 -10
- data/lib/icontrol/web_accelerator/policies.rb +13 -9
- data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
- data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
- data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
- metadata +10 -4
data/lib/icontrol/lt_config.rb
CHANGED
|
@@ -1,9 +1,16 @@
|
|
|
1
1
|
module IControl::LTConfig
|
|
2
2
|
|
|
3
3
|
class ClassInstanceKey < IControl::Base::Struct; end
|
|
4
|
+
class ClassInstanceKeySequence < IControl::Base::Sequence ; end
|
|
5
|
+
class ClassInstanceKeySequenceSequence < IControl::Base::SequenceSequence ; end
|
|
4
6
|
class Klass < IControl::Base; end
|
|
5
7
|
class Field < IControl::Base; end##
|
|
6
|
-
# A class instance key specifies fully a class instance. The model is: the loosely-typed
|
|
8
|
+
# A class instance key specifies fully a class instance. The model is: the loosely-typed
|
|
9
|
+
# configuration system has as meta-data classes and fields. A class contains a number
|
|
10
|
+
# of fields; that is a structural description of data. To complete the model, an instance
|
|
11
|
+
# of a class contains data values. (More accurately, class instances contain data values
|
|
12
|
+
# by containing field instances). The members of this structure can be read: &quot;name"
|
|
13
|
+
# is an instance of class &quot;class_name" inside object &quot;container".
|
|
7
14
|
# @attr [String] container The class instance in which the instance resides.
|
|
8
15
|
# @attr [String] container_class Unused at this time.
|
|
9
16
|
# @attr [String] class_name The object given by structure member "name" (below) is an instance of this class.
|
|
@@ -1,16 +1,19 @@
|
|
|
1
1
|
module IControl::LTConfig
|
|
2
2
|
##
|
|
3
|
-
# The Field interface enables you to manage fields and field instances in the Loosely-Typed
|
|
3
|
+
# The Field interface enables you to manage fields and field instances in the Loosely-Typed
|
|
4
|
+
# Configuration system.
|
|
4
5
|
class Field < IControl::Base
|
|
5
6
|
|
|
6
7
|
set_id_name "class_names"
|
|
7
8
|
|
|
8
|
-
##
|
|
9
|
-
# Gets application data for one or more loosely-typed configuration fields for this
|
|
9
|
+
class EnabledStateSequenceSequence < IControl::Base::SequenceSequence ; end ##
|
|
10
|
+
# Gets application data for one or more loosely-typed configuration fields for this
|
|
11
|
+
# classes. This is the &quot;back-end application hook".
|
|
12
|
+
# @rspec_example
|
|
10
13
|
# @return [String[]]
|
|
11
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
12
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
13
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
14
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
15
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
16
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
14
17
|
# @param [Hash] opts
|
|
15
18
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get type information, with one list for each class specified, each with one entry for each field requested.
|
|
16
19
|
def application_data(opts)
|
|
@@ -19,11 +22,13 @@ module IControl::LTConfig
|
|
|
19
22
|
end
|
|
20
23
|
|
|
21
24
|
##
|
|
22
|
-
# Gets the clustered state for one or more specified loosely-typed configuration fields
|
|
25
|
+
# Gets the clustered state for one or more specified loosely-typed configuration fields
|
|
26
|
+
# for this classes. If the field is clustered, that means don't use the default.
|
|
27
|
+
# @rspec_example
|
|
23
28
|
# @return [EnabledState[]]
|
|
24
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
25
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
26
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
29
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
30
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
31
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
27
32
|
# @param [Hash] opts
|
|
28
33
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get clustered states, with one list for each class specified, each with one entry for each field requested.
|
|
29
34
|
def clustered_state(opts)
|
|
@@ -32,11 +37,13 @@ module IControl::LTConfig
|
|
|
32
37
|
end
|
|
33
38
|
|
|
34
39
|
##
|
|
35
|
-
# Gets the configsyncd state for one or more specified loosely-typed configuration
|
|
40
|
+
# Gets the configsyncd state for one or more specified loosely-typed configuration
|
|
41
|
+
# fields for this classes. If the field is configsyncd, that means don't use the default.
|
|
42
|
+
# @rspec_example
|
|
36
43
|
# @return [EnabledState[]]
|
|
37
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
38
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
39
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
44
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
45
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
46
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
40
47
|
# @param [Hash] opts
|
|
41
48
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get configsyncd states, with one list for each class specified, each with one entry for each field requested.
|
|
42
49
|
def configsyncd_state(opts)
|
|
@@ -45,11 +52,14 @@ module IControl::LTConfig
|
|
|
45
52
|
end
|
|
46
53
|
|
|
47
54
|
##
|
|
48
|
-
# Gets db variable mirror information for one or more loosely-typed configuration fields
|
|
55
|
+
# Gets db variable mirror information for one or more loosely-typed configuration fields
|
|
56
|
+
# for this classes. This, if non-empty, indicates which db variable should have its
|
|
57
|
+
# value mirrored with this field.
|
|
58
|
+
# @rspec_example
|
|
49
59
|
# @return [String[]]
|
|
50
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
51
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
52
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
60
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
61
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
62
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
53
63
|
# @param [Hash] opts
|
|
54
64
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get type information, with one list for each class specified, each with one entry for each field requested.
|
|
55
65
|
def db_variable_mirror_information(opts)
|
|
@@ -58,11 +68,13 @@ module IControl::LTConfig
|
|
|
58
68
|
end
|
|
59
69
|
|
|
60
70
|
##
|
|
61
|
-
# Gets default value information for one or more loosely-typed configuration fields
|
|
71
|
+
# Gets default value information for one or more loosely-typed configuration fields
|
|
72
|
+
# for this classes.
|
|
73
|
+
# @rspec_example
|
|
62
74
|
# @return [String[]]
|
|
63
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
64
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
65
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
75
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
76
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
77
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
66
78
|
# @param [Hash] opts
|
|
67
79
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get type information, with one list for each class specified, each with one entry for each field requested.
|
|
68
80
|
def default(opts)
|
|
@@ -71,11 +83,13 @@ module IControl::LTConfig
|
|
|
71
83
|
end
|
|
72
84
|
|
|
73
85
|
##
|
|
74
|
-
# Gets display name information for one or more loosely-typed configuration fields
|
|
86
|
+
# Gets display name information for one or more loosely-typed configuration fields
|
|
87
|
+
# for this classes.
|
|
88
|
+
# @rspec_example
|
|
75
89
|
# @return [String[]]
|
|
76
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
77
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
78
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
90
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
91
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
92
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
79
93
|
# @param [Hash] opts
|
|
80
94
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get type information, with one list for each class specified, each with one entry for each field requested.
|
|
81
95
|
def display_name(opts)
|
|
@@ -85,20 +99,23 @@ module IControl::LTConfig
|
|
|
85
99
|
|
|
86
100
|
##
|
|
87
101
|
# Gets a list of loosely-typed configuration fields for this classes.
|
|
102
|
+
# @rspec_example
|
|
88
103
|
# @return [String[]]
|
|
89
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
90
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
91
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
104
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
105
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
106
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
92
107
|
def list
|
|
93
108
|
super
|
|
94
109
|
end
|
|
95
110
|
|
|
96
111
|
##
|
|
97
|
-
# Gets the required state for one or more specified loosely-typed configuration fields
|
|
112
|
+
# Gets the required state for one or more specified loosely-typed configuration fields
|
|
113
|
+
# for this classes. If the field is required, that means don't use the default.
|
|
114
|
+
# @rspec_example
|
|
98
115
|
# @return [EnabledState[]]
|
|
99
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
100
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
101
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
116
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
117
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
118
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
102
119
|
# @param [Hash] opts
|
|
103
120
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get required states, with one list for each class specified, each with one entry for each field requested.
|
|
104
121
|
def required_state(opts)
|
|
@@ -107,11 +124,15 @@ module IControl::LTConfig
|
|
|
107
124
|
end
|
|
108
125
|
|
|
109
126
|
##
|
|
110
|
-
# Gets type information for one or more loosely-typed configuration fields for this
|
|
127
|
+
# Gets type information for one or more loosely-typed configuration fields for this
|
|
128
|
+
# classes. (This is not to be confused with type; type information gives information
|
|
129
|
+
# relevant to the processing of a basic type, for example, type int might have type
|
|
130
|
+
# information specifying min and max value).
|
|
131
|
+
# @rspec_example
|
|
111
132
|
# @return [String[]]
|
|
112
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
113
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
114
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
133
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
134
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
135
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
115
136
|
# @param [Hash] opts
|
|
116
137
|
# @option opts [String[]] :field_names A list of (list of) fields for which to get type information, with one list for each class specified, each with one entry for each field requested.
|
|
117
138
|
def type_information(opts)
|
|
@@ -120,11 +141,15 @@ module IControl::LTConfig
|
|
|
120
141
|
end
|
|
121
142
|
|
|
122
143
|
##
|
|
123
|
-
# Gets the value for one loosely-typed configuration field instance for this class
|
|
144
|
+
# Gets the value for one loosely-typed configuration field instance for this class
|
|
145
|
+
# instance. This is for convenience, when you want to get just one value in just one
|
|
146
|
+
# class instance. Use get_values instead for greater efficiency when getting multiple
|
|
147
|
+
# field values.
|
|
148
|
+
# @rspec_example
|
|
124
149
|
# @return [String]
|
|
125
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
126
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
127
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
150
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
151
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
152
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
128
153
|
# @param [Hash] opts
|
|
129
154
|
# @option opts [IControl::LTConfig::ClassInstanceKey] :class_instance_key The class instance containing the field of interest.
|
|
130
155
|
# @option opts [String] :field_instance_name A field instance for which to get value.
|
|
@@ -134,11 +159,13 @@ module IControl::LTConfig
|
|
|
134
159
|
end
|
|
135
160
|
|
|
136
161
|
##
|
|
137
|
-
# Gets values for one or more loosely-typed configuration field instances for this
|
|
162
|
+
# Gets values for one or more loosely-typed configuration field instances for this
|
|
163
|
+
# class instances.
|
|
164
|
+
# @rspec_example
|
|
138
165
|
# @return [String[]]
|
|
139
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
140
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
141
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
166
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
167
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
168
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
142
169
|
# @param [Hash] opts
|
|
143
170
|
# @option opts [IControl::LTConfig::ClassInstanceKey] :class_instance_keys The class instances containing the fields of interest.
|
|
144
171
|
# @option opts [String[]] :field_instance_names A list of (list of) field instances for which to get values, with one list for each class instance specified, each with one entry for each field requested. As a convenience, if the fields are the same for each class instance, you may pass just 1 list of fields to be used for all class instances. In any case, the class instance must have the fields requested on pain of exception.
|
|
@@ -149,16 +176,21 @@ module IControl::LTConfig
|
|
|
149
176
|
|
|
150
177
|
##
|
|
151
178
|
# Gets the version information for this interface.
|
|
179
|
+
# @rspec_example
|
|
152
180
|
# @return [String]
|
|
153
181
|
def version
|
|
154
182
|
super
|
|
155
183
|
end
|
|
156
184
|
|
|
157
185
|
##
|
|
158
|
-
# Sets the value for one loosely-typed configuration field instance for this class
|
|
159
|
-
#
|
|
160
|
-
#
|
|
161
|
-
#
|
|
186
|
+
# Sets the value for one loosely-typed configuration field instance for this class
|
|
187
|
+
# instance. This is for convenience, when you want to set just one value in just one
|
|
188
|
+
# class instance. Use set_values instead for greater efficiency when setting multiple
|
|
189
|
+
# field values.
|
|
190
|
+
# @rspec_example
|
|
191
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
192
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
193
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
162
194
|
# @param [Hash] opts
|
|
163
195
|
# @option opts [boolean] :create_instances_if_needed Whether to create the class instances if needed.
|
|
164
196
|
# @option opts [IControl::LTConfig::ClassInstanceKey] :class_instance_key The class instance containing the field of interest.
|
|
@@ -170,10 +202,12 @@ module IControl::LTConfig
|
|
|
170
202
|
end
|
|
171
203
|
|
|
172
204
|
##
|
|
173
|
-
# Sets values for one or more loosely-typed configuration field instances for this
|
|
174
|
-
#
|
|
175
|
-
# @
|
|
176
|
-
# @raise [IControl::Common::
|
|
205
|
+
# Sets values for one or more loosely-typed configuration field instances for this
|
|
206
|
+
# class instances.
|
|
207
|
+
# @rspec_example
|
|
208
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
209
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
210
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
177
211
|
# @param [Hash] opts
|
|
178
212
|
# @option opts [boolean] :create_instances_if_needed Whether to create the class instances if needed.
|
|
179
213
|
# @option opts [IControl::LTConfig::ClassInstanceKey] :class_instance_keys The class instances containing the fields of interest.
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
module IControl::LTConfig
|
|
2
2
|
##
|
|
3
|
-
# The Class interface enables you to manage classes and class instances in the Loosely-Typed
|
|
3
|
+
# The Class interface enables you to manage classes and class instances in the Loosely-Typed
|
|
4
|
+
# Configuration system.
|
|
4
5
|
class Klass < IControl::Base
|
|
5
6
|
|
|
6
7
|
set_id_name "class_names"
|
|
7
8
|
|
|
8
9
|
##
|
|
9
10
|
# Creates a loosely-typed configuration class instance.
|
|
10
|
-
# @
|
|
11
|
-
# @raise [IControl::Common::
|
|
12
|
-
# @raise [IControl::Common::
|
|
11
|
+
# @rspec_example
|
|
12
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
13
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
14
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
13
15
|
# @param [Hash] opts
|
|
14
16
|
# @option opts [IControl::LTConfig::ClassInstanceKey] :class_instance_keys Class instance keys defining the keys for the new instances. Each of these specifies the name of the instance, the class name of the instance, and if appropriate, a container class for the instance.
|
|
15
17
|
def create_instance(opts)
|
|
@@ -19,9 +21,10 @@ module IControl::LTConfig
|
|
|
19
21
|
|
|
20
22
|
##
|
|
21
23
|
# Deletes a loosely-typed configuration class instance.
|
|
22
|
-
# @
|
|
23
|
-
# @raise [IControl::Common::
|
|
24
|
-
# @raise [IControl::Common::
|
|
24
|
+
# @rspec_example
|
|
25
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
26
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
27
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
25
28
|
# @param [Hash] opts
|
|
26
29
|
# @option opts [IControl::LTConfig::ClassInstanceKey] :class_instance_keys Class instance keys defining the keys for the instances to delete. Each of these specifies the name of the instance, the class name of the instance, and if appropriate, a container class for the instance.
|
|
27
30
|
def delete_instance(opts)
|
|
@@ -31,126 +34,139 @@ module IControl::LTConfig
|
|
|
31
34
|
|
|
32
35
|
##
|
|
33
36
|
# Gets the category for this loosely-typed configuration classes.
|
|
37
|
+
# @rspec_example
|
|
34
38
|
# @return [String]
|
|
35
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
36
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
37
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
39
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
40
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
41
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
38
42
|
def category
|
|
39
43
|
super
|
|
40
44
|
end
|
|
41
45
|
|
|
42
46
|
##
|
|
43
47
|
# Gets the clustered state for this loosely-typed configuration classes.
|
|
48
|
+
# @rspec_example
|
|
44
49
|
# @return [EnabledState]
|
|
45
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
46
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
47
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
50
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
51
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
52
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
48
53
|
def clustered_state
|
|
49
54
|
super
|
|
50
55
|
end
|
|
51
56
|
|
|
52
57
|
##
|
|
53
58
|
# Gets the configsyncd state for this loosely-typed configuration classes.
|
|
59
|
+
# @rspec_example
|
|
54
60
|
# @return [EnabledState]
|
|
55
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
56
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
57
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
61
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
62
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
63
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
58
64
|
def configsyncd_state
|
|
59
65
|
super
|
|
60
66
|
end
|
|
61
67
|
|
|
62
68
|
##
|
|
63
69
|
# Gets the constraints for this loosely-typed configuration classes.
|
|
70
|
+
# @rspec_example
|
|
64
71
|
# @return [String[]]
|
|
65
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
66
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
67
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
72
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
73
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
74
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
68
75
|
def constraints
|
|
69
76
|
super
|
|
70
77
|
end
|
|
71
78
|
|
|
72
79
|
##
|
|
73
80
|
# Gets the field count for this loosely-typed configuration classes.
|
|
81
|
+
# @rspec_example
|
|
74
82
|
# @return [long]
|
|
75
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
76
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
77
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
83
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
84
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
85
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
78
86
|
def field_count
|
|
79
87
|
super
|
|
80
88
|
end
|
|
81
89
|
|
|
82
90
|
##
|
|
83
91
|
# Gets a list of loosely-typed configuration classes.
|
|
92
|
+
# @rspec_example
|
|
84
93
|
# @return [String]
|
|
85
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
86
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
87
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
94
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
95
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
96
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
88
97
|
def list
|
|
89
98
|
super
|
|
90
99
|
end
|
|
91
100
|
|
|
92
101
|
##
|
|
93
102
|
# Gets a list of loosely-typed configuration class instances.
|
|
103
|
+
# @rspec_example
|
|
94
104
|
# @return [ClassInstanceKey[]]
|
|
95
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
96
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
97
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
105
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
106
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
107
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
98
108
|
def list_of_instances
|
|
99
109
|
super
|
|
100
110
|
end
|
|
101
111
|
|
|
102
112
|
##
|
|
103
113
|
# Gets the nested classes for this loosely-typed configuration classes.
|
|
114
|
+
# @rspec_example
|
|
104
115
|
# @return [String[]]
|
|
105
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
106
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
107
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
116
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
117
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
118
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
108
119
|
def nested_classes
|
|
109
120
|
super
|
|
110
121
|
end
|
|
111
122
|
|
|
112
123
|
##
|
|
113
124
|
# Gets the partitioned state for this loosely-typed configuration classes.
|
|
125
|
+
# @rspec_example
|
|
114
126
|
# @return [EnabledState]
|
|
115
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
116
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
117
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
127
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
128
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
129
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
118
130
|
def partitioned_state
|
|
119
131
|
super
|
|
120
132
|
end
|
|
121
133
|
|
|
122
134
|
##
|
|
123
135
|
# Gets the singleton state for this loosely-typed configuration classes.
|
|
136
|
+
# @rspec_example
|
|
124
137
|
# @return [EnabledState]
|
|
125
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
126
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
127
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
138
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
139
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
140
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
128
141
|
def singleton_state
|
|
129
142
|
super
|
|
130
143
|
end
|
|
131
144
|
|
|
132
145
|
##
|
|
133
146
|
# Gets the statistics for this loosely-typed configuration classes.
|
|
147
|
+
# @rspec_example
|
|
134
148
|
# @return [String[]]
|
|
135
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
136
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
137
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
149
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
150
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
151
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
138
152
|
def statistics
|
|
139
153
|
super
|
|
140
154
|
end
|
|
141
155
|
|
|
142
156
|
##
|
|
143
157
|
# Gets the toplevelcmd state for this loosely-typed configuration classes.
|
|
158
|
+
# @rspec_example
|
|
144
159
|
# @return [EnabledState]
|
|
145
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
146
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
147
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
160
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
161
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
162
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
148
163
|
def toplevelcmd_state
|
|
149
164
|
super
|
|
150
165
|
end
|
|
151
166
|
|
|
152
167
|
##
|
|
153
168
|
# Gets the version information for this interface.
|
|
169
|
+
# @rspec_example
|
|
154
170
|
# @return [String]
|
|
155
171
|
def version
|
|
156
172
|
super
|