icontrol 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -1,17 +1,21 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The ProfilePersistence interface enables you to manipulate a local load balancer's Persistence profile.
3
+ # The ProfilePersistence interface enables you to manipulate a local load balancer's
4
+ # Persistence profile.
4
5
  class ProfilePersistence < IControl::Base
5
6
 
6
7
  set_id_name "profile_names"
7
8
 
8
9
  class ProfilePersistenceHashMethod < IControl::Base::Struct; end
10
+ class PersistenceHashMethodSequence < IControl::Base::Sequence ; end
11
+ class ProfilePersistenceHashMethodSequence < IControl::Base::Sequence ; end
9
12
  # Persistence hash methods used for persisting connections
10
13
  class PersistenceHashMethod < IControl::Base::Enumeration; end ##
11
14
  # Creates this Persistence profile.
12
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
13
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
14
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
15
+ # @rspec_example
16
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
17
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
18
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
15
19
  # @param [Hash] opts
16
20
  # @option opts [IControl::LocalLB::PersistenceMode] :modes The persistence modes for the specified profiles.
17
21
  def create(opts)
@@ -21,294 +25,356 @@ module IControl::LocalLB
21
25
 
22
26
  ##
23
27
  # Deletes all Persistence profile.
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.
28
+ # @rspec_example
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
  def delete_all_profiles
28
33
  super
29
34
  end
30
35
 
31
36
  ##
32
37
  # Deletes this Persistence profile.
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.
38
+ # @rspec_example
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.
36
42
  def delete_profile
37
43
  super
38
44
  end
39
45
 
40
46
  ##
41
- # Gets the states to indicate whether persistence entries added under this profile are available across pools.
47
+ # Gets the states to indicate whether persistence entries added under this profile
48
+ # are available across pools.
49
+ # @rspec_example
42
50
  # @return [ProfileEnabledState]
43
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
51
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
52
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
53
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
46
54
  def across_pool_state
47
55
  super
48
56
  end
49
57
 
50
58
  ##
51
- # Gets the states to indicate whether persistence entries added under this profile are available across services.
59
+ # Gets the states to indicate whether persistence entries added under this profile
60
+ # are available across services.
61
+ # @rspec_example
52
62
  # @return [ProfileEnabledState]
53
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
54
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
55
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
63
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
64
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
65
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
56
66
  def across_service_state
57
67
  super
58
68
  end
59
69
 
60
70
  ##
61
- # Gets the states to indicate whether persistence entries added under this profile are available across virtuals.
71
+ # Gets the states to indicate whether persistence entries added under this profile
72
+ # are available across virtuals.
73
+ # @rspec_example
62
74
  # @return [ProfileEnabledState]
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
  def across_virtual_state
67
79
  super
68
80
  end
69
81
 
70
82
  ##
71
- # Gets the cookie expiration in seconds for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.
83
+ # Gets the cookie expiration in seconds for this Persistence profile. Applicable when
84
+ # peristence mode is PERSISTENCE_MODE_COOKIE.
85
+ # @rspec_example
72
86
  # @return [ProfileULong]
73
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
74
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
75
- # @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.
76
90
  def cookie_expiration
77
91
  super
78
92
  end
79
93
 
80
94
  ##
81
- # Gets the cookie hash lengths for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
95
+ # Gets the cookie hash lengths for this profile. Applicable when peristence mode is
96
+ # PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
97
+ # @rspec_example
82
98
  # @return [ProfileULong]
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.
99
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
100
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
101
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
86
102
  def cookie_hash_length
87
103
  super
88
104
  end
89
105
 
90
106
  ##
91
- # Gets the cookie hash offsets for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
107
+ # Gets the cookie hash offsets for this profile. Applicable when peristence mode is
108
+ # PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
109
+ # @rspec_example
92
110
  # @return [ProfileULong]
93
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
94
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
95
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
111
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
112
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
113
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
96
114
  def cookie_hash_offset
97
115
  super
98
116
  end
99
117
 
100
118
  ##
101
- # Gets the cookie names for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.
119
+ # Gets the cookie names for this Persistence profile. Applicable when peristence mode
120
+ # is PERSISTENCE_MODE_COOKIE.
121
+ # @rspec_example
102
122
  # @return [ProfileString]
103
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
104
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
105
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
123
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
124
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
125
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
106
126
  def cookie_name
107
127
  super
108
128
  end
109
129
 
110
130
  ##
111
- # Gets the cookie persistence methods to be used when in cookie persistence mode. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.
131
+ # Gets the cookie persistence methods to be used when in cookie persistence mode. Applicable
132
+ # when peristence mode is PERSISTENCE_MODE_COOKIE.
133
+ # @rspec_example
112
134
  # @return [ProfileCookiePersistenceMethod]
113
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
115
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
135
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
136
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
137
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
116
138
  def cookie_persistence_method
117
139
  super
118
140
  end
119
141
 
120
142
  ##
121
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
143
+ # Gets the names of the default profile from which this profile will derive default
144
+ # values for its attributes.
145
+ # @rspec_example
122
146
  # @return [String]
123
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
124
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
125
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
147
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
148
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
149
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
126
150
  def default_profile
127
151
  super
128
152
  end
129
153
 
130
154
  ##
131
- # Gets the pattern marking the end of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
155
+ # Gets the pattern marking the end of the section of payload data whose hashed value
156
+ # is used for the persistence value for a set of persistence profile. This only returns
157
+ # useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method
158
+ # is PERSISTENCE_HASH_CARP.
159
+ # @rspec_example
132
160
  # @return [ProfileString]
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.
161
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
162
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
163
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
136
164
  def ending_hash_pattern
137
165
  super
138
166
  end
139
167
 
140
168
  ##
141
- # Gets the length of payload data whose hashed value is used for the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
169
+ # Gets the length of payload data whose hashed value is used for the persistence value
170
+ # for a set of persistence profile. This only returns useful values if the persistence
171
+ # mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
172
+ # @rspec_example
142
173
  # @return [ProfileULong]
143
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
144
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
145
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
174
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
175
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
176
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
146
177
  def hash_length
147
178
  super
148
179
  end
149
180
 
150
181
  ##
151
- # Gets the hash method used to generate the persistence values for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH.
182
+ # Gets the hash method used to generate the persistence values for a set of persistence
183
+ # profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH.
184
+ # @rspec_example
152
185
  # @return [ProfilePersistenceHashMethod]
153
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
154
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
155
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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 hash_method
157
190
  super
158
191
  end
159
192
 
160
193
  ##
161
- # Gets the enabled state whether to perform another hash operation after the current hash operation completes for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
194
+ # Gets the enabled state whether to perform another hash operation after the current
195
+ # hash operation completes for a set of persistence profile. This only returns useful
196
+ # values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
197
+ # @rspec_example
162
198
  # @return [ProfileEnabledState]
163
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
164
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
165
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
166
202
  def hash_more_data_state
167
203
  super
168
204
  end
169
205
 
170
206
  ##
171
- # Gets the offset to the start of the payload data whose hashed value is used as the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
207
+ # Gets the offset to the start of the payload data whose hashed value is used as the
208
+ # persistence value for a set of persistence profile. This only returns useful values
209
+ # if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
210
+ # @rspec_example
172
211
  # @return [ProfileULong]
173
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
174
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
175
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
212
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
213
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
214
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
176
215
  def hash_offset
177
216
  super
178
217
  end
179
218
 
180
219
  ##
181
220
  # Gets a list of all Persistence profile.
221
+ # @rspec_example
182
222
  # @return [String]
183
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
184
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
185
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
223
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
224
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
225
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
186
226
  def list
187
227
  super
188
228
  end
189
229
 
190
230
  ##
191
- # Gets the states to indicate whether to map known proxies when the persistence mode is source address affinity.
231
+ # Gets the states to indicate whether to map known proxies when the persistence mode
232
+ # is source address affinity.
233
+ # @rspec_example
192
234
  # @return [ProfileEnabledState]
193
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
194
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
195
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
235
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
236
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
237
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
196
238
  def map_proxy_state
197
239
  super
198
240
  end
199
241
 
200
242
  ##
201
243
  # Gets the masks used in either simple or sticky persistence mode.
244
+ # @rspec_example
202
245
  # @return [ProfileIPAddress]
203
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
204
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
205
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
206
249
  def mask
207
250
  super
208
251
  end
209
252
 
210
253
  ##
211
- # Gets the maximum size of the buffer used to hold the section of the payload data whose hashed value is used for the persistence value for a set of persistence values. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
254
+ # Gets the maximum size of the buffer used to hold the section of the payload data
255
+ # whose hashed value is used for the persistence value for a set of persistence values.
256
+ # This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH
257
+ # and the hash method is PERSISTENCE_HASH_CARP.
258
+ # @rspec_example
212
259
  # @return [ProfileULong]
213
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
214
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
215
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
216
263
  def maximum_hash_buffer_size
217
264
  super
218
265
  end
219
266
 
220
267
  ##
221
268
  # Gets the mirror states for this Persistence profile.
269
+ # @rspec_example
222
270
  # @return [ProfileEnabledState]
223
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
224
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
225
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
271
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
272
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
273
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
226
274
  def mirror_state
227
275
  super
228
276
  end
229
277
 
230
278
  ##
231
- # Gets the states to indicate whether MS terminal services have been configured without a session directory for this Persistence profile.
279
+ # Gets the states to indicate whether MS terminal services have been configured without
280
+ # a session directory for this Persistence profile.
281
+ # @rspec_example
232
282
  # @return [ProfileEnabledState]
233
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
234
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
235
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
283
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
284
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
285
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
236
286
  def msrdp_without_session_directory_state
237
287
  super
238
288
  end
239
289
 
240
290
  ##
241
291
  # Gets the persistence modes for this Persistence profile.
292
+ # @rspec_example
242
293
  # @return [ProfilePersistenceMode]
243
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
244
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
245
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
294
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
295
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
296
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
246
297
  def persistence_mode
247
298
  super
248
299
  end
249
300
 
250
301
  ##
251
- # Gets the UIE rules for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_UIE.
302
+ # Gets the UIE rules for this Persistence profile. Applicable when peristence mode
303
+ # is PERSISTENCE_MODE_UIE.
304
+ # @rspec_example
252
305
  # @return [ProfileString]
253
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
254
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
255
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
306
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
307
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
308
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
256
309
  def rule
257
310
  super
258
311
  end
259
312
 
260
313
  ##
261
- # Gets the sip_info headers for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_SIP.
314
+ # Gets the sip_info headers for this Persistence profile. Applicable when peristence
315
+ # mode is PERSISTENCE_MODE_SIP.
316
+ # @rspec_example
262
317
  # @return [ProfileString]
263
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
264
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
265
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
318
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
319
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
320
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
266
321
  def sip_info
267
322
  super
268
323
  end
269
324
 
270
325
  ##
271
- # Gets the pattern marking the start of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
326
+ # Gets the pattern marking the start of the section of payload data whose hashed value
327
+ # is used for the persistence value for a set of persistence profile. This only returns
328
+ # useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method
329
+ # is PERSISTENCE_HASH_CARP.
330
+ # @rspec_example
272
331
  # @return [ProfileString]
273
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
274
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
275
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
332
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
333
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
334
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
276
335
  def starting_hash_pattern
277
336
  super
278
337
  end
279
338
 
280
339
  ##
281
- # Gets the timeout for this Persistence profile. The number of seconds to timeout a persistence entry.
340
+ # Gets the timeout for this Persistence profile. The number of seconds to timeout a
341
+ # persistence entry.
342
+ # @rspec_example
282
343
  # @return [ProfileULong]
283
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
284
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
285
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
344
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
345
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
346
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
286
347
  def timeout
287
348
  super
288
349
  end
289
350
 
290
351
  ##
291
352
  # Gets the version information for this interface.
353
+ # @rspec_example
292
354
  # @return [String]
293
355
  def version
294
356
  super
295
357
  end
296
358
 
297
359
  ##
298
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
360
+ # Determines whether this profile are base/pre-configured profile, or user-defined
361
+ # profile.
362
+ # @rspec_example
299
363
  # @return [boolean]
300
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
301
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
302
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
364
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
365
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
366
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
303
367
  def is_base_profile
304
368
  super
305
369
  end
306
370
 
307
371
  ##
308
- # Sets the states to indicate whether persistence entries added under this profile are available across pools.
309
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
310
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
311
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
372
+ # Sets the states to indicate whether persistence entries added under this profile
373
+ # are available across pools.
374
+ # @rspec_example
375
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
376
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
377
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
312
378
  # @param [Hash] opts
313
379
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Persistence profiles.
314
380
  def set_across_pool_state(opts)
@@ -317,10 +383,12 @@ module IControl::LocalLB
317
383
  end
318
384
 
319
385
  ##
320
- # Sets the states to indicate whether persistence entries added under this profile are available across services.
321
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
322
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
323
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
386
+ # Sets the states to indicate whether persistence entries added under this profile
387
+ # are available across services.
388
+ # @rspec_example
389
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
390
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
391
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
324
392
  # @param [Hash] opts
325
393
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Persistence profiles.
326
394
  def set_across_service_state(opts)
@@ -329,10 +397,12 @@ module IControl::LocalLB
329
397
  end
330
398
 
331
399
  ##
332
- # Sets the states to indicate whether persistence entries added under this profile are available across virtuals.
333
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
334
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
335
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
400
+ # Sets the states to indicate whether persistence entries added under this profile
401
+ # are available across virtuals.
402
+ # @rspec_example
403
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
404
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
405
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
336
406
  # @param [Hash] opts
337
407
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Persistence profiles.
338
408
  def set_across_virtual_state(opts)
@@ -341,10 +411,12 @@ module IControl::LocalLB
341
411
  end
342
412
 
343
413
  ##
344
- # Sets the cookie expiration in seconds for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.
345
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
346
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
347
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
414
+ # Sets the cookie expiration in seconds for this Persistence profile. Applicable when
415
+ # peristence mode is PERSISTENCE_MODE_COOKIE.
416
+ # @rspec_example
417
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
418
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
419
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
348
420
  # @param [Hash] opts
349
421
  # @option opts [IControl::LocalLB::ProfileULong] :expirations The cookie expirations for the specified Persistence profiles.
350
422
  def set_cookie_expiration(opts)
@@ -353,10 +425,12 @@ module IControl::LocalLB
353
425
  end
354
426
 
355
427
  ##
356
- # Sets the cookie hash lengths for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
357
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
358
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
359
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
428
+ # Sets the cookie hash lengths for this profile. Applicable when peristence mode is
429
+ # PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
430
+ # @rspec_example
431
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
432
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
433
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
360
434
  # @param [Hash] opts
361
435
  # @option opts [IControl::LocalLB::ProfileULong] :lengths The cookie hash lengths for the specified Persistence profiles.
362
436
  def set_cookie_hash_length(opts)
@@ -365,10 +439,12 @@ module IControl::LocalLB
365
439
  end
366
440
 
367
441
  ##
368
- # Sets the cookie hash offsets for this profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
369
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
370
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
371
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
442
+ # Sets the cookie hash offsets for this profile. Applicable when peristence mode is
443
+ # PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH.
444
+ # @rspec_example
445
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
446
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
447
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
372
448
  # @param [Hash] opts
373
449
  # @option opts [IControl::LocalLB::ProfileULong] :offsets The cookie hash offsets for the specified Persistence profiles.
374
450
  def set_cookie_hash_offset(opts)
@@ -377,10 +453,12 @@ module IControl::LocalLB
377
453
  end
378
454
 
379
455
  ##
380
- # Sets the cookie names for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.
381
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
382
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
383
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
456
+ # Sets the cookie names for this Persistence profile. Applicable when peristence mode
457
+ # is PERSISTENCE_MODE_COOKIE.
458
+ # @rspec_example
459
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
460
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
461
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
384
462
  # @param [Hash] opts
385
463
  # @option opts [IControl::LocalLB::ProfileString] :cookie_names The cookie names for the specified Persistence profiles.
386
464
  def set_cookie_name(opts)
@@ -389,10 +467,12 @@ module IControl::LocalLB
389
467
  end
390
468
 
391
469
  ##
392
- # Sets the cookie persistence methods to be used when in cookie persistence mode. Applicable when peristence mode is PERSISTENCE_MODE_COOKIE.
393
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
394
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
395
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
470
+ # Sets the cookie persistence methods to be used when in cookie persistence mode. Applicable
471
+ # when peristence mode is PERSISTENCE_MODE_COOKIE.
472
+ # @rspec_example
473
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
474
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
475
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
396
476
  # @param [Hash] opts
397
477
  # @option opts [IControl::LocalLB::ProfileCookiePersistenceMethod] :methods The cookie persistence methods for the specified Persistence profiles.
398
478
  def set_cookie_persistence_method(opts)
@@ -401,10 +481,12 @@ module IControl::LocalLB
401
481
  end
402
482
 
403
483
  ##
404
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
405
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
406
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
407
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
484
+ # Sets the names of the default profile from which this profile will derive default
485
+ # values for its attributes.
486
+ # @rspec_example
487
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
488
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
489
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
408
490
  # @param [Hash] opts
409
491
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
410
492
  def set_default_profile(opts)
@@ -413,10 +495,15 @@ module IControl::LocalLB
413
495
  end
414
496
 
415
497
  ##
416
- # Sets the pattern marking the end of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. The hash payload data is either delimited by this starting and ending string pattern or the offset and length, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
417
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
418
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
419
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
498
+ # Sets the pattern marking the end of the section of payload data whose hashed value
499
+ # is used for the persistence value for a set of persistence profile. The hash payload
500
+ # data is either delimited by this starting and ending string pattern or the offset
501
+ # and length, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH
502
+ # and the hash method is PERSISTENCE_HASH_CARP.
503
+ # @rspec_example
504
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
505
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
506
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
420
507
  # @param [Hash] opts
421
508
  # @option opts [IControl::LocalLB::ProfileString] :patterns
422
509
  def set_ending_hash_pattern(opts)
@@ -425,10 +512,15 @@ module IControl::LocalLB
425
512
  end
426
513
 
427
514
  ##
428
- # Sets the length of payload data whose hashed value is used for the persistence value for a set of persistence profile. The start of the data is specified via set_hash_offset. The hash payload data is either delimited by this offset and length or the starting and ending string pattern, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
429
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
430
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
431
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
515
+ # Sets the length of payload data whose hashed value is used for the persistence value
516
+ # for a set of persistence profile. The start of the data is specified via set_hash_offset.
517
+ # The hash payload data is either delimited by this offset and length or the starting
518
+ # and ending string pattern, not both. This is only applicable when the persistence
519
+ # mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
520
+ # @rspec_example
521
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
522
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
523
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
432
524
  # @param [Hash] opts
433
525
  # @option opts [IControl::LocalLB::ProfileULong] :lengths Hashed payload data length (bytes) for each specified persistence profile (default: 0). If zero, the hashed payload data is not specified by an offset and length.
434
526
  def set_hash_length(opts)
@@ -437,10 +529,13 @@ module IControl::LocalLB
437
529
  end
438
530
 
439
531
  ##
440
- # Sets the hash method used to generate the persistence values for a set of persistence profile. See PersistenceHashMethod for details. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH.
441
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
442
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
443
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
532
+ # Sets the hash method used to generate the persistence values for a set of persistence
533
+ # profile. See PersistenceHashMethod for details. This is only applicable when the
534
+ # persistence mode is PERSISTENCE_MODE_HASH.
535
+ # @rspec_example
536
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
537
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
538
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
444
539
  # @param [Hash] opts
445
540
  # @option opts [IControl::LocalLB::ProfilePersistence::ProfilePersistenceHashMethod] :methods Persistence method for each specified profile (default: PERSISTENCE_HASH_DEFAULT)
446
541
  def set_hash_method(opts)
@@ -449,10 +544,13 @@ module IControl::LocalLB
449
544
  end
450
545
 
451
546
  ##
452
- # Sets the enabled state whether to perform another hash operation after the current hash operation completes for a set of persistence profile. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
453
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
454
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
455
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
547
+ # Sets the enabled state whether to perform another hash operation after the current
548
+ # hash operation completes for a set of persistence profile. This is only applicable
549
+ # when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
550
+ # @rspec_example
551
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
552
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
553
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
456
554
  # @param [Hash] opts
457
555
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states Enabled state for more hashing for each specified persistence profile (default: disabled)
458
556
  def set_hash_more_data_state(opts)
@@ -461,10 +559,14 @@ module IControl::LocalLB
461
559
  end
462
560
 
463
561
  ##
464
- # Sets the offset to the start of the payload data whose hashed value is used as the persistence value for a set of persistence profile. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. The hashed payload data length is specified via set_hash_length.
465
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
466
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
467
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
562
+ # Sets the offset to the start of the payload data whose hashed value is used as the
563
+ # persistence value for a set of persistence profile. This is only applicable when
564
+ # the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
565
+ # The hashed payload data length is specified via set_hash_length.
566
+ # @rspec_example
567
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
568
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
569
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
468
570
  # @param [Hash] opts
469
571
  # @option opts [IControl::LocalLB::ProfileULong] :offsets Payload data offset (bytes) to the start of the hashed data for each specified persistence profile (default: 0)
470
572
  def set_hash_offset(opts)
@@ -473,10 +575,12 @@ module IControl::LocalLB
473
575
  end
474
576
 
475
577
  ##
476
- # Sets the states to indicate whether to map known proxies when the persistence mode is source address affinity.
477
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
478
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
479
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
578
+ # Sets the states to indicate whether to map known proxies when the persistence mode
579
+ # is source address affinity.
580
+ # @rspec_example
581
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
582
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
583
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
480
584
  # @param [Hash] opts
481
585
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Persistence profiles.
482
586
  def set_map_proxy_state(opts)
@@ -486,9 +590,10 @@ module IControl::LocalLB
486
590
 
487
591
  ##
488
592
  # Sets the masks used in either simple or sticky persistence mode.
489
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
490
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
491
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
593
+ # @rspec_example
594
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
595
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
596
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
492
597
  # @param [Hash] opts
493
598
  # @option opts [IControl::LocalLB::ProfileIPAddress] :masks The masks for the specified Persistence profiles.
494
599
  def set_mask(opts)
@@ -497,10 +602,14 @@ module IControl::LocalLB
497
602
  end
498
603
 
499
604
  ##
500
- # Sets the maximum size of the buffer used to hold the section of the payload data whose hashed value is used for the persistence value for a set of persistence values. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
501
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
502
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
503
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
605
+ # Sets the maximum size of the buffer used to hold the section of the payload data
606
+ # whose hashed value is used for the persistence value for a set of persistence values.
607
+ # This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the
608
+ # hash method is PERSISTENCE_HASH_CARP.
609
+ # @rspec_example
610
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
611
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
612
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
504
613
  # @param [Hash] opts
505
614
  # @option opts [IControl::LocalLB::ProfileULong] :sizes Maximum hashed data buffer size (bytes) for each specified persistence profile (default: 0)
506
615
  def set_maximum_hash_buffer_size(opts)
@@ -510,9 +619,10 @@ module IControl::LocalLB
510
619
 
511
620
  ##
512
621
  # Sets the mirror states for this Persistence profile.
513
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
514
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
515
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
622
+ # @rspec_example
623
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
624
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
625
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
516
626
  # @param [Hash] opts
517
627
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states indicating whether to mirror persistence records.
518
628
  def set_mirror_state(opts)
@@ -521,10 +631,12 @@ module IControl::LocalLB
521
631
  end
522
632
 
523
633
  ##
524
- # Sets the states to indicate whether MS terminal services have been configured without a session directory for this Persistence profile.
525
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
526
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
527
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
634
+ # Sets the states to indicate whether MS terminal services have been configured without
635
+ # a session directory for this Persistence profile.
636
+ # @rspec_example
637
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
638
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
639
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
528
640
  # @param [Hash] opts
529
641
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified Persistence profiles.
530
642
  def set_msrdp_without_session_directory_state(opts)
@@ -534,9 +646,10 @@ module IControl::LocalLB
534
646
 
535
647
  ##
536
648
  # Sets the persistence modes for this Persistence profile.
537
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
538
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
539
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
649
+ # @rspec_example
650
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
651
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
652
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
540
653
  # @param [Hash] opts
541
654
  # @option opts [IControl::LocalLB::ProfilePersistenceMode] :modes The persistence modes for the specified profiles.
542
655
  def set_persistence_mode(opts)
@@ -545,10 +658,12 @@ module IControl::LocalLB
545
658
  end
546
659
 
547
660
  ##
548
- # Sets the UIE rules for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_UIE.
549
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
550
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
551
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
661
+ # Sets the UIE rules for this Persistence profile. Applicable when peristence mode
662
+ # is PERSISTENCE_MODE_UIE.
663
+ # @rspec_example
664
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
665
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
666
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
552
667
  # @param [Hash] opts
553
668
  # @option opts [IControl::LocalLB::ProfileString] :rules The UIE rules for the specified Persistence profiles.
554
669
  def set_rule(opts)
@@ -557,10 +672,12 @@ module IControl::LocalLB
557
672
  end
558
673
 
559
674
  ##
560
- # Sets the sip_info header for this Persistence profile. Applicable when peristence mode is PERSISTENCE_MODE_SIP.
561
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
562
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
563
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
675
+ # Sets the sip_info header for this Persistence profile. Applicable when peristence
676
+ # mode is PERSISTENCE_MODE_SIP.
677
+ # @rspec_example
678
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
679
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
680
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
564
681
  # @param [Hash] opts
565
682
  # @option opts [IControl::LocalLB::ProfileString] :sip_info_headers The sip_info headers for the specified Persistence profiles. Possible values are: 'Call-ID', 'To', 'From', 'SIP-ETag', 'Subject'.
566
683
  def set_sip_info(opts)
@@ -569,10 +686,14 @@ module IControl::LocalLB
569
686
  end
570
687
 
571
688
  ##
572
- # Sets the pattern marking the start of the section of payload data whose hashed value is used for the persistence value for a set of persistence profile. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP.
573
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
574
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
575
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
689
+ # Sets the pattern marking the start of the section of payload data whose hashed value
690
+ # is used for the persistence value for a set of persistence profile. This is only
691
+ # applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method
692
+ # is PERSISTENCE_HASH_CARP.
693
+ # @rspec_example
694
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
695
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
696
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
576
697
  # @param [Hash] opts
577
698
  # @option opts [IControl::LocalLB::ProfileString] :patterns
578
699
  def set_starting_hash_pattern(opts)
@@ -581,10 +702,12 @@ module IControl::LocalLB
581
702
  end
582
703
 
583
704
  ##
584
- # Sets the timeout for this Persistence profile. The number of seconds to timeout a persistence entry.
585
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
586
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
587
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
705
+ # Sets the timeout for this Persistence profile. The number of seconds to timeout a
706
+ # persistence entry.
707
+ # @rspec_example
708
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
709
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
710
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
588
711
  # @param [Hash] opts
589
712
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeouts for the specified Persistence profiles.
590
713
  def set_timeout(opts)