icontrol 0.3.1 → 0.3.2
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -1,61 +1,67 @@
|
|
1
1
|
module IControl::System
|
2
2
|
##
|
3
|
-
# The Cluster interface enables you to work with the definitions and attributes in
|
3
|
+
# The Cluster interface enables you to work with the definitions and attributes in
|
4
|
+
# a clustered device.
|
4
5
|
class Cluster < IControl::Base
|
5
6
|
|
6
7
|
set_id_name "cluster_names"
|
7
8
|
|
8
9
|
##
|
9
10
|
# Gets the cluster enabled states.
|
11
|
+
# @rspec_example
|
10
12
|
# @return [EnabledState]
|
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::Common::NotImplemented] raised if the method is not supported or implemented.
|
13
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
14
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
15
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
16
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
15
17
|
def cluster_enabled_state
|
16
18
|
super
|
17
19
|
end
|
18
20
|
|
19
21
|
##
|
20
22
|
# Gets the cluster high-availability states.
|
23
|
+
# @rspec_example
|
21
24
|
# @return [HAState]
|
22
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
23
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
24
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
25
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
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.
|
28
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
26
29
|
def cluster_ha_state
|
27
30
|
super
|
28
31
|
end
|
29
32
|
|
30
33
|
##
|
31
34
|
# Gets the primary slot numbers.
|
35
|
+
# @rspec_example
|
32
36
|
# @return [long]
|
33
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
34
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
35
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
36
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
37
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
38
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
39
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
40
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
37
41
|
def current_primary_slot
|
38
42
|
super
|
39
43
|
end
|
40
44
|
|
41
45
|
##
|
42
46
|
# Gets a list of the cluster names.
|
47
|
+
# @rspec_example
|
43
48
|
# @return [String]
|
44
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
45
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
46
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
47
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
49
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
50
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
51
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
52
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
48
53
|
def list
|
49
54
|
super
|
50
55
|
end
|
51
56
|
|
52
57
|
##
|
53
58
|
# Gets the cluster member enabled states.
|
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.
|
58
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
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.
|
64
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
59
65
|
# @param [Hash] opts
|
60
66
|
# @option opts [long[]] :slot_ids The list of lists of slot ids.
|
61
67
|
def member_enabled_state(opts)
|
@@ -65,11 +71,12 @@ module IControl::System
|
|
65
71
|
|
66
72
|
##
|
67
73
|
# Gets the cluster member high-availability states.
|
74
|
+
# @rspec_example
|
68
75
|
# @return [HAState[]]
|
69
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
70
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
71
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
72
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
76
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
77
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
78
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
79
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
73
80
|
# @param [Hash] opts
|
74
81
|
# @option opts [long[]] :slot_ids The list of lists of slot ids.
|
75
82
|
def member_ha_state(opts)
|
@@ -79,11 +86,12 @@ module IControl::System
|
|
79
86
|
|
80
87
|
##
|
81
88
|
# Gets the cluster member licensed states.
|
89
|
+
# @rspec_example
|
82
90
|
# @return [EnabledState[]]
|
83
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
84
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
85
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
86
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
91
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
92
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
93
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
94
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
87
95
|
# @param [Hash] opts
|
88
96
|
# @option opts [long[]] :slot_ids The list of lists of slot ids.
|
89
97
|
def member_licensed_state(opts)
|
@@ -93,11 +101,12 @@ module IControl::System
|
|
93
101
|
|
94
102
|
##
|
95
103
|
# Gets the cluster member priming states.
|
104
|
+
# @rspec_example
|
96
105
|
# @return [EnabledState[]]
|
97
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
98
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
99
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
100
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
106
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
107
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
108
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
109
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
101
110
|
# @param [Hash] opts
|
102
111
|
# @option opts [long[]] :slot_ids The list of lists of slot ids.
|
103
112
|
def member_priming_state(opts)
|
@@ -107,50 +116,55 @@ module IControl::System
|
|
107
116
|
|
108
117
|
##
|
109
118
|
# Gets the minimum up members values.
|
119
|
+
# @rspec_example
|
110
120
|
# @return [long]
|
111
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
112
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
113
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
114
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
121
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
122
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
123
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
124
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
115
125
|
def min_up_members
|
116
126
|
super
|
117
127
|
end
|
118
128
|
|
119
129
|
##
|
120
130
|
# Gets the cluster minimum up members actions.
|
131
|
+
# @rspec_example
|
121
132
|
# @return [HAAction]
|
122
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
123
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
124
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
125
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
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.
|
136
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
126
137
|
def min_up_members_action
|
127
138
|
super
|
128
139
|
end
|
129
140
|
|
130
141
|
##
|
131
142
|
# Gets the cluster minimum up members enabled states.
|
143
|
+
# @rspec_example
|
132
144
|
# @return [EnabledState]
|
133
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
134
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
135
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
136
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
145
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
146
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
147
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
148
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
137
149
|
def min_up_members_state
|
138
150
|
super
|
139
151
|
end
|
140
152
|
|
141
153
|
##
|
142
154
|
# Get a list of list of slot ids (the size of each list is the number of slots).
|
155
|
+
# @rspec_example
|
143
156
|
# @return [long[]]
|
144
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
145
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
146
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
147
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
157
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
158
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
159
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
160
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
148
161
|
def slot_id
|
149
162
|
super
|
150
163
|
end
|
151
164
|
|
152
165
|
##
|
153
166
|
# Gets the version information for this interface.
|
167
|
+
# @rspec_example
|
154
168
|
# @return [String]
|
155
169
|
def version
|
156
170
|
super
|
@@ -158,21 +172,23 @@ module IControl::System
|
|
158
172
|
|
159
173
|
##
|
160
174
|
# Checks to see whether the system is a clustered environment.
|
175
|
+
# @rspec_example
|
161
176
|
# @return [boolean]
|
162
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
163
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
164
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
165
|
-
# @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
177
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
178
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
179
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
180
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
166
181
|
def is_clustered_environment
|
167
182
|
super
|
168
183
|
end
|
169
184
|
|
170
185
|
##
|
171
186
|
# Sets the cluster enabled states.
|
172
|
-
# @
|
173
|
-
# @raise [IControl::Common::
|
174
|
-
# @raise [IControl::Common::
|
175
|
-
# @raise [IControl::Common::
|
187
|
+
# @rspec_example
|
188
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
189
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
190
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
191
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
176
192
|
# @param [Hash] opts
|
177
193
|
# @option opts [IControl::Common::EnabledState] :cluster_states The list of enabled states.
|
178
194
|
def set_cluster_enabled_state(opts)
|
@@ -182,10 +198,11 @@ module IControl::System
|
|
182
198
|
|
183
199
|
##
|
184
200
|
# Currently this is not implemented.
|
185
|
-
# @
|
186
|
-
# @raise [IControl::Common::
|
187
|
-
# @raise [IControl::Common::
|
188
|
-
# @raise [IControl::Common::
|
201
|
+
# @rspec_example
|
202
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
203
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
204
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
205
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
189
206
|
# @param [Hash] opts
|
190
207
|
# @option opts [long] :primary_slots
|
191
208
|
def set_current_primary_slot(opts)
|
@@ -195,10 +212,11 @@ module IControl::System
|
|
195
212
|
|
196
213
|
##
|
197
214
|
# Sets the cluster member enabled states.
|
198
|
-
# @
|
199
|
-
# @raise [IControl::Common::
|
200
|
-
# @raise [IControl::Common::
|
201
|
-
# @raise [IControl::Common::
|
215
|
+
# @rspec_example
|
216
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
217
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
218
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
219
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
202
220
|
# @param [Hash] opts
|
203
221
|
# @option opts [long[]] :slot_ids The list of lists of slot ids.
|
204
222
|
# @option opts [IControl::Common::EnabledState[]] :member_states
|
@@ -209,10 +227,11 @@ module IControl::System
|
|
209
227
|
|
210
228
|
##
|
211
229
|
# Sets the cluster member priming states.
|
212
|
-
# @
|
213
|
-
# @raise [IControl::Common::
|
214
|
-
# @raise [IControl::Common::
|
215
|
-
# @raise [IControl::Common::
|
230
|
+
# @rspec_example
|
231
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
232
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
233
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
234
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
216
235
|
# @param [Hash] opts
|
217
236
|
# @option opts [long[]] :slot_ids The list of lists of slot ids.
|
218
237
|
# @option opts [IControl::Common::EnabledState[]] :priming_states The list of lists of priming states.
|
@@ -223,10 +242,11 @@ module IControl::System
|
|
223
242
|
|
224
243
|
##
|
225
244
|
# Sets the minimum up members values.
|
226
|
-
# @
|
227
|
-
# @raise [IControl::Common::
|
228
|
-
# @raise [IControl::Common::
|
229
|
-
# @raise [IControl::Common::
|
245
|
+
# @rspec_example
|
246
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
247
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
248
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
249
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
230
250
|
# @param [Hash] opts
|
231
251
|
# @option opts [long] :min_up_members The list of minimum up members values.
|
232
252
|
def set_min_up_members(opts)
|
@@ -236,10 +256,11 @@ module IControl::System
|
|
236
256
|
|
237
257
|
##
|
238
258
|
# Sets the cluster minimum up members actions.
|
239
|
-
# @
|
240
|
-
# @raise [IControl::Common::
|
241
|
-
# @raise [IControl::Common::
|
242
|
-
# @raise [IControl::Common::
|
259
|
+
# @rspec_example
|
260
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
261
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
262
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
263
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
243
264
|
# @param [Hash] opts
|
244
265
|
# @option opts [IControl::Common::HAAction] :min_up_actions The list of minimum up members actions.
|
245
266
|
def set_min_up_members_action(opts)
|
@@ -249,10 +270,11 @@ module IControl::System
|
|
249
270
|
|
250
271
|
##
|
251
272
|
# Sets the cluster minimum up members enabled states.
|
252
|
-
# @
|
253
|
-
# @raise [IControl::Common::
|
254
|
-
# @raise [IControl::Common::
|
255
|
-
# @raise [IControl::Common::
|
273
|
+
# @rspec_example
|
274
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
275
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
276
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
277
|
+
# @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
|
256
278
|
# @param [Hash] opts
|
257
279
|
# @option opts [IControl::Common::EnabledState] :min_up_states The list of minimum up members enabled states.
|
258
280
|
def set_min_up_members_state(opts)
|
@@ -1,12 +1,18 @@
|
|
1
1
|
module IControl::System
|
2
2
|
##
|
3
|
-
# The ConfigSync interface enables you to work with configuration files. For example,
|
3
|
+
# The ConfigSync interface enables you to work with configuration files. For example,
|
4
|
+
# use the ConfigSync interface to retrieve a configuration file list, roll up and save
|
5
|
+
# a specified configuration, install a configuration on a device, synchronize configuration
|
6
|
+
# setups, roll back a configuration, and upload or download a configuration.
|
4
7
|
class ConfigSync < IControl::Base
|
5
8
|
|
6
9
|
set_id_name "filename"
|
7
10
|
|
8
11
|
class ConfigFileEntry < IControl::Base::Struct; end
|
9
12
|
class FileTransferContext < IControl::Base::Struct; end
|
13
|
+
class ConfigExcludeComponentSequence < IControl::Base::Sequence ; end
|
14
|
+
class ConfigFileSequence < IControl::Base::Sequence ; end
|
15
|
+
class ConfigIncludeComponentSequence < IControl::Base::Sequence ; end
|
10
16
|
# An enumeration of excluded component flags used in configuration save.
|
11
17
|
class ConfigExcludeComponent < IControl::Base::Enumeration; end
|
12
18
|
# An enumeration of included component flags used in configuration save.
|
@@ -17,29 +23,38 @@ module IControl::System
|
|
17
23
|
class SaveMode < IControl::Base::Enumeration; end
|
18
24
|
# An enumeration of synchronization flags used in configuration sync.
|
19
25
|
class SyncMode < IControl::Base::Enumeration; end ##
|
20
|
-
# Deletes this configuration from the archive directory. If this file doesn't exist,
|
21
|
-
#
|
22
|
-
#
|
23
|
-
#
|
26
|
+
# Deletes this configuration from the archive directory. If this file doesn't exist,
|
27
|
+
# an exception will be raised. The specified configuration should not contain any path
|
28
|
+
# information since it is restricted to be in the archive directory. NOTE: File names
|
29
|
+
# containing the following characters will be considered invalid: ` ~ / \ : ; * ? &quot;
|
30
|
+
# &lt; &gt; | &amp;
|
31
|
+
# @rspec_example
|
32
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
33
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
34
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
24
35
|
def delete_configuration
|
25
36
|
super
|
26
37
|
end
|
27
38
|
|
28
39
|
##
|
29
|
-
# Deletes this file from the device. If this file doesn't exist, an exception will
|
30
|
-
#
|
31
|
-
#
|
32
|
-
# @
|
40
|
+
# Deletes this file from the device. If this file doesn't exist, an exception will
|
41
|
+
# be raised. NOTE: File names containing the following characters will be considered
|
42
|
+
# invalid: ` ~ \ : ; * ? &quot; &lt; &gt; | &amp;
|
43
|
+
# @rspec_example
|
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.
|
33
47
|
def delete_file
|
34
48
|
super
|
35
49
|
end
|
36
50
|
|
37
51
|
##
|
38
52
|
# Downloads the configurations from the device.
|
53
|
+
# @rspec_example
|
39
54
|
# @return [FileTransferContext]
|
40
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
41
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
42
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
55
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
56
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
57
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
43
58
|
# @param [Hash] opts
|
44
59
|
# @option opts [String] :config_name The name of the configuration file to be retrieved from the device. Length limit: 255. The configuration name should not include any path information, since it will be retrieved automatically from a designated directory.
|
45
60
|
# @option opts [long] :chunk_size The chunk/block size of the file data to read from the device.
|
@@ -51,10 +66,11 @@ module IControl::System
|
|
51
66
|
|
52
67
|
##
|
53
68
|
# A generic file download mechanism to download a file from the device.
|
69
|
+
# @rspec_example
|
54
70
|
# @return [FileTransferContext]
|
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.
|
71
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
72
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
73
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
58
74
|
# @param [Hash] opts
|
59
75
|
# @option opts [String] :file_name The name of the file to be retrieved from the device. Length limit: 255.
|
60
76
|
# @option opts [long] :chunk_size The chunk/block size of the file data to read from the device.
|
@@ -66,35 +82,42 @@ module IControl::System
|
|
66
82
|
|
67
83
|
##
|
68
84
|
# Gets a list of all available configuration archives on the system.
|
85
|
+
# @rspec_example
|
69
86
|
# @return [ConfigFileEntry]
|
70
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
71
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
72
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
87
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
88
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
89
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
73
90
|
def configuration_list
|
74
91
|
super
|
75
92
|
end
|
76
93
|
|
77
94
|
##
|
78
95
|
# Gets the version information for this interface.
|
96
|
+
# @rspec_example
|
79
97
|
# @return [String]
|
80
98
|
def version
|
81
99
|
super
|
82
100
|
end
|
83
101
|
|
84
102
|
##
|
85
|
-
# Installs the configurations contained in this archive to the local device using the
|
86
|
-
#
|
87
|
-
# @
|
88
|
-
# @raise [IControl::Common::
|
103
|
+
# Installs the configurations contained in this archive to the local device using the
|
104
|
+
# &apos;all' flag.
|
105
|
+
# @rspec_example
|
106
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
107
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
108
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
89
109
|
def install_all_configuration
|
90
110
|
super
|
91
111
|
end
|
92
112
|
|
93
113
|
##
|
94
|
-
# Installs the encrypted configurations contained in this archive to the local device
|
95
|
-
#
|
96
|
-
#
|
97
|
-
# @
|
114
|
+
# Installs the encrypted configurations contained in this archive to the local device
|
115
|
+
# using the &apos;all' flag. If this archive is not already encrypted, then the
|
116
|
+
# passphrase is ignored, and installation will take place as normal.
|
117
|
+
# @rspec_example
|
118
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
119
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
120
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
98
121
|
# @param [Hash] opts
|
99
122
|
# @option opts [String] :passphrase The passphrase used to decrypt the archive so we can install it.
|
100
123
|
def install_all_encrypted_configuration(opts)
|
@@ -104,18 +127,22 @@ module IControl::System
|
|
104
127
|
|
105
128
|
##
|
106
129
|
# Installs the configurations contained in this archive to the local device.
|
107
|
-
# @
|
108
|
-
# @raise [IControl::Common::
|
109
|
-
# @raise [IControl::Common::
|
130
|
+
# @rspec_example
|
131
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
132
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
133
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
110
134
|
def install_configuration
|
111
135
|
super
|
112
136
|
end
|
113
137
|
|
114
138
|
##
|
115
|
-
# Installs the encrypted configurations contained in this archive to the local device.
|
116
|
-
#
|
117
|
-
#
|
118
|
-
# @
|
139
|
+
# Installs the encrypted configurations contained in this archive to the local device.
|
140
|
+
# If this archive is not already encrypted, then the passphrase is ignored, and installation
|
141
|
+
# will take place as normal.
|
142
|
+
# @rspec_example
|
143
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
144
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
145
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
119
146
|
# @param [Hash] opts
|
120
147
|
# @option opts [String] :passphrase The passphrase used to decrypt the archive so we can install it.
|
121
148
|
def install_encrypted_configuration(opts)
|
@@ -124,10 +151,13 @@ module IControl::System
|
|
124
151
|
end
|
125
152
|
|
126
153
|
##
|
127
|
-
# Load this configuration. If this configuration in &quot;filenam" is empty, then
|
128
|
-
#
|
129
|
-
#
|
130
|
-
# @
|
154
|
+
# Load this configuration. If this configuration in &quot;filenam" is empty, then
|
155
|
+
# by default, /config/bigip.conf will be loaded if the &quot;load_flag" is LOAD_HIGH_LEVEL_CONFIG,
|
156
|
+
# and /config/bigip_base.conf will be loaded if the &quot;load_flag" is LOAD_BASE_LEVEL_CONFIG.
|
157
|
+
# @rspec_example
|
158
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
159
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
160
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
131
161
|
# @param [Hash] opts
|
132
162
|
# @option opts [IControl::System::ConfigSync::LoadMode] :load_flag The flag specifying the type of load to perform.
|
133
163
|
def load_configuration(opts)
|
@@ -136,10 +166,12 @@ module IControl::System
|
|
136
166
|
end
|
137
167
|
|
138
168
|
##
|
139
|
-
# A generic file move mechanism to move files on a device. This call does a rename
|
140
|
-
#
|
141
|
-
# @
|
142
|
-
# @raise [IControl::Common::
|
169
|
+
# A generic file move mechanism to move files on a device. This call does a rename
|
170
|
+
# of the file and will not work across filesystem boundaries.
|
171
|
+
# @rspec_example
|
172
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
173
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
174
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
143
175
|
# @param [Hash] opts
|
144
176
|
# @option opts [String] :from_path The full path of the file to be moved.
|
145
177
|
# @option opts [String] :to_path The full path for the file to moved to.
|
@@ -150,18 +182,23 @@ module IControl::System
|
|
150
182
|
|
151
183
|
##
|
152
184
|
# Rolls back to the previous configuration.
|
153
|
-
# @
|
154
|
-
# @raise [IControl::Common::
|
155
|
-
# @raise [IControl::Common::
|
185
|
+
# @rspec_example
|
186
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
187
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
188
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
156
189
|
def rollback_configuration
|
157
190
|
super
|
158
191
|
end
|
159
192
|
|
160
193
|
##
|
161
|
-
# Saves the current configurations to this archive. If the &quot;save_flag" is
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
194
|
+
# Saves the current configurations to this archive. If the &quot;save_flag" is
|
195
|
+
# either SAVE_HIGH_LEVEL_CONFIG or SAVE_BASE_LEVEL_CONFIG, this filenam will be ignored,
|
196
|
+
# since by default, configuration will be saved into /config/bigip.conf or /config/bigip_base.conf
|
197
|
+
# respectively.
|
198
|
+
# @rspec_example
|
199
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
200
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
201
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
165
202
|
# @param [Hash] opts
|
166
203
|
# @option opts [IControl::System::ConfigSync::SaveMode] :save_flag The flag specifying the type of save to perform.
|
167
204
|
def save_configuration(opts)
|
@@ -170,10 +207,12 @@ module IControl::System
|
|
170
207
|
end
|
171
208
|
|
172
209
|
##
|
173
|
-
# Saves and encrypts the current configurations to this archive. This method is used
|
174
|
-
#
|
175
|
-
# @
|
176
|
-
# @raise [IControl::Common::
|
210
|
+
# Saves and encrypts the current configurations to this archive. This method is used
|
211
|
+
# to save whole configuration archive, not just what's in bigip.conf or bigip_base.conf.
|
212
|
+
# @rspec_example
|
213
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
214
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
215
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
177
216
|
# @param [Hash] opts
|
178
217
|
# @option opts [String] :passphrase The passphrase used to encrypt the saved archive.
|
179
218
|
def save_encrypted_configuration(opts)
|
@@ -182,10 +221,17 @@ module IControl::System
|
|
182
221
|
end
|
183
222
|
|
184
223
|
##
|
185
|
-
# Saves the current configurations to this archive. If the &quot;save_flag" is
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
224
|
+
# Saves the current configurations to this archive. If the &quot;save_flag" is
|
225
|
+
# either SAVE_HIGH_LEVEL_CONFIG or SAVE_BASE_LEVEL_CONFIG, this filenam will be ignored,
|
226
|
+
# since by default, configuration will be saved into /config/bigip.conf or /config/bigip_base.conf
|
227
|
+
# respectively. If any &quot;features_to_exclude" components are specified, those
|
228
|
+
# components are excluded from the configuration. If any &quot;features_to_include"
|
229
|
+
# components are specified, those components are included from the configuration. Note
|
230
|
+
# that feature inclusion/exclusion will only work when the save flag is &quot;SAVE_FULL".
|
231
|
+
# @rspec_example
|
232
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
233
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
234
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
189
235
|
# @param [Hash] opts
|
190
236
|
# @option opts [IControl::System::ConfigSync::SaveMode] :save_flag The flag specifying the type of save to perform.
|
191
237
|
# @option opts [IControl::System::ConfigSync::ConfigExcludeComponent] :features_to_exclude standard features to be excluded from saved configuration
|
@@ -196,10 +242,16 @@ module IControl::System
|
|
196
242
|
end
|
197
243
|
|
198
244
|
##
|
199
|
-
# Saves and encrypts the current configurations to this archive. This method is used
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
245
|
+
# Saves and encrypts the current configurations to this archive. This method is used
|
246
|
+
# to save whole configuration archive, not just what's in bigip.conf or bigip_base.conf.
|
247
|
+
# If any &quot;features_to_exclude" components are specified, those components
|
248
|
+
# are excluded from the configuration. If any &quot;features_to_include" components
|
249
|
+
# are specified, those components are included from the configuration. Note that feature
|
250
|
+
# inclusion/exclusion will only work when the save flag is &quot;SAVE_FULL".
|
251
|
+
# @rspec_example
|
252
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
253
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
254
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
203
255
|
# @param [Hash] opts
|
204
256
|
# @option opts [String] :passphrase The passphrase used to encrypt the saved archive.
|
205
257
|
# @option opts [IControl::System::ConfigSync::ConfigExcludeComponent] :features_to_exclude standard features to be excluded from saved configuration
|
@@ -210,10 +262,12 @@ module IControl::System
|
|
210
262
|
end
|
211
263
|
|
212
264
|
##
|
213
|
-
# Synchronizes the configurations between the two devices in a redundant system. In
|
214
|
-
#
|
215
|
-
# @
|
216
|
-
# @raise [IControl::Common::
|
265
|
+
# Synchronizes the configurations between the two devices in a redundant system. In
|
266
|
+
# the case of cache devices, synchronizes the configurations across the cluster.
|
267
|
+
# @rspec_example
|
268
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
269
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
270
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
217
271
|
# @param [Hash] opts
|
218
272
|
# @option opts [IControl::System::ConfigSync::SyncMode] :sync_flag The mode of synchronization between the devices.
|
219
273
|
def synchronize_configuration(opts)
|
@@ -223,9 +277,10 @@ module IControl::System
|
|
223
277
|
|
224
278
|
##
|
225
279
|
# Uploads the configurations to the device.
|
226
|
-
# @
|
227
|
-
# @raise [IControl::Common::
|
228
|
-
# @raise [IControl::Common::
|
280
|
+
# @rspec_example
|
281
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
282
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
283
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
229
284
|
# @param [Hash] opts
|
230
285
|
# @option opts [String] :config_name The name of the configuration archive to be saved on the device. Length limit: 255. The configuration name should not include any path information, since it will be saved automatically to a designated directory. The file chunk size is implicitly known by calculating the length of the contents of the configuration data ( see file_data parameter) being uploaded.
|
231
286
|
# @option opts [IControl::System::ConfigSync::FileTransferContext] :file_context The context of the transfer operation.
|
@@ -236,9 +291,10 @@ module IControl::System
|
|
236
291
|
|
237
292
|
##
|
238
293
|
# A generic file upload mechanism to transfer a file to the device.
|
239
|
-
# @
|
240
|
-
# @raise [IControl::Common::
|
241
|
-
# @raise [IControl::Common::
|
294
|
+
# @rspec_example
|
295
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
296
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
297
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
242
298
|
# @param [Hash] opts
|
243
299
|
# @option opts [String] :file_name The name of the file to be saved on the device. Length limit: 255. The file chunk size is implicitly known by calculating the length of the contents of the file data ( see file_data parameter) being uploaded.
|
244
300
|
# @option opts [IControl::System::ConfigSync::FileTransferContext] :file_context The context of the transfer operation.
|
@@ -258,10 +314,10 @@ module IControl::System
|
|
258
314
|
|
259
315
|
##
|
260
316
|
# A struct that describes a file transfer context.
|
261
|
-
# @attr [
|
317
|
+
# @attr [StringSequence] file_data The actual file content for the transfer operation.
|
262
318
|
# @attr [IControl::Common::FileChainType] chain_type The flag used to indicate whether this is FIRST, MIDDLE, or LAST chunk of the file data.
|
263
319
|
class FileTransferContext < IControl::Base::Struct
|
264
|
-
icontrol_attribute :file_data,
|
320
|
+
icontrol_attribute :file_data, StringSequence
|
265
321
|
icontrol_attribute :chain_type, IControl::Common::FileChainType
|
266
322
|
end
|
267
323
|
|