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,22 +1,33 @@
1
1
  module IControl::System
2
2
  ##
3
- # The GeoIP interface enables you to maintain the GeoIP location database. The location database maps IP addresses to geographical locations.
3
+ # The GeoIP interface enables you to maintain the GeoIP location database. The location
4
+ # database maps IP addresses to geographical locations.
4
5
  class GeoIP < IControl::Base
5
6
 
6
7
  set_id_name "nil"
7
8
 
8
9
  ##
9
10
  # Gets the version information for this interface.
11
+ # @rspec_example
10
12
  # @return [String]
11
13
  def version
12
14
  super
13
15
  end
14
16
 
15
17
  ##
16
- # Loads GeoIP data files into the running configuration. The directory /shared/GeoIP is used for user files (as opposed to the information shipped with the system). The user files override the system files according to the preferences shown below. Note: You can use the upload_file method (ConfigSync interface) to get data files to the system. The system has the following order of preference when loading files. Order of precedence for IPv4 mapping: /shared/GeoIP/GeoIPCity.dat /shared/GeoIP/GeoIPRegion.dat /shared/GeoIP/GeoIP.dat /usr/share/GeoIP/F5GeoIP.dat Order of precedence for IPv6 mapping: /shared/GeoIP/GeoIPv6.dat /usr/share/GeoIP/F5GeoIPv6.dat ISP: /shared/GeoIP/GeoIPISP.dat Organization: /shared/GeoIP/GeoIPOrg.dat
17
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
18
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
19
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
18
+ # Loads GeoIP data files into the running configuration. The directory /shared/GeoIP
19
+ # is used for user files (as opposed to the information shipped with the system). The
20
+ # user files override the system files according to the preferences shown below. Note:
21
+ # You can use the upload_file method (ConfigSync interface) to get data files to the
22
+ # system. The system has the following order of preference when loading files. Order
23
+ # of precedence for IPv4 mapping: /shared/GeoIP/GeoIPCity.dat /shared/GeoIP/GeoIPRegion.dat
24
+ # /shared/GeoIP/GeoIP.dat /usr/share/GeoIP/F5GeoIP.dat Order of precedence for IPv6
25
+ # mapping: /shared/GeoIP/GeoIPv6.dat /usr/share/GeoIP/F5GeoIPv6.dat ISP: /shared/GeoIP/GeoIPISP.dat
26
+ # Organization: /shared/GeoIP/GeoIPOrg.dat
27
+ # @rspec_example
28
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
29
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
30
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
20
31
  def load
21
32
  super
22
33
  end
@@ -1,42 +1,49 @@
1
1
  module IControl::System
2
2
  ##
3
- # The Inet interface exposes the internal API functionality that you can use to manipulate the rc.conf and resolv.conf files. The ntp.conf file includes the functionality that you can use to set and get the following settings: host name, IP address (get only), router, NTP server and DNS server.
3
+ # The Inet interface exposes the internal API functionality that you can use to manipulate
4
+ # the rc.conf and resolv.conf files. The ntp.conf file includes the functionality that
5
+ # you can use to set and get the following settings: host name, IP address (get only),
6
+ # router, NTP server and DNS server.
4
7
  class Inet < IControl::Base
5
8
 
6
9
  set_id_name "hostnames"
7
10
 
8
11
  ##
9
12
  # Gets the IP addresses that the device is using as its DNS servers.
13
+ # @rspec_example
10
14
  # @return [String]
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
15
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
17
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
18
  def dns_server_address
15
19
  super
16
20
  end
17
21
 
18
22
  ##
19
23
  # Gets the host name of the device.
24
+ # @rspec_example
20
25
  # @return [String]
21
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
22
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
23
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
26
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
27
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
28
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
24
29
  def hostname
25
30
  super
26
31
  end
27
32
 
28
33
  ##
29
34
  # Gets the IP address/host name that that the device is using for its NTP service.
35
+ # @rspec_example
30
36
  # @return [String]
31
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
32
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
33
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
34
40
  def ntp_server_address
35
41
  super
36
42
  end
37
43
 
38
44
  ##
39
45
  # Gets the version information for this interface.
46
+ # @rspec_example
40
47
  # @return [String]
41
48
  def version
42
49
  super
@@ -44,20 +51,22 @@ module IControl::System
44
51
 
45
52
  ##
46
53
  # Translate this hostname to IP addresses.
54
+ # @rspec_example
47
55
  # @return [String]
48
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
56
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
57
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
58
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
51
59
  def hostname_to_ip
52
60
  super
53
61
  end
54
62
 
55
63
  ##
56
64
  # Translate this IP addresses into hostname.
65
+ # @rspec_example
57
66
  # @return [String]
58
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
59
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
60
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
67
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
68
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
69
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
61
70
  # @param [Hash] opts
62
71
  # @option opts [String] :ip_addresses The list of IP addresses to translate into hostnames.
63
72
  def ip_to_hostname(opts)
@@ -66,11 +75,14 @@ module IControl::System
66
75
  end
67
76
 
68
77
  ##
69
- # Translate this service names to service numbers. If a service name can not be translated into an equivalent service number, a service number of 0 will be returned for that service name.
78
+ # Translate this service names to service numbers. If a service name can not be translated
79
+ # into an equivalent service number, a service number of 0 will be returned for that
80
+ # service name.
81
+ # @rspec_example
70
82
  # @return [long]
71
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
72
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
73
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
83
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
84
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
85
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
74
86
  # @param [Hash] opts
75
87
  # @option opts [String] :service_names The list of hostnames to translate into IP addresses
76
88
  def service_name_to_service_number(opts)
@@ -79,11 +91,14 @@ module IControl::System
79
91
  end
80
92
 
81
93
  ##
82
- # Translate this service numbers into service names. If an service number can not be translated into an equivalent service name, the string format of the service number will be returned.
94
+ # Translate this service numbers into service names. If an service number can not be
95
+ # translated into an equivalent service name, the string format of the service number
96
+ # will be returned.
97
+ # @rspec_example
83
98
  # @return [String]
84
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
85
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
86
- # @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.
87
102
  # @param [Hash] opts
88
103
  # @option opts [long] :services The list of service numbers to translate into service names.
89
104
  def service_number_to_service_name(opts)
@@ -93,9 +108,10 @@ module IControl::System
93
108
 
94
109
  ##
95
110
  # Sets the host name of the device.
96
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
97
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
98
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
111
+ # @rspec_example
112
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
113
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
114
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
99
115
  # @param [Hash] opts
100
116
  # @option opts [String] :hostname The new hostname to set.
101
117
  def set_hostname(opts)
@@ -105,9 +121,10 @@ module IControl::System
105
121
 
106
122
  ##
107
123
  # Configures the IP address/host name that the device uses for its NTP service.
108
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
109
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
110
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
124
+ # @rspec_example
125
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
126
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
127
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
111
128
  # @param [Hash] opts
112
129
  # @option opts [String] :ntp_addresses The IP addresses/host names of valid NTP servers.
113
130
  def set_ntp_server_address(opts)
@@ -5,8 +5,10 @@ module IControl::System
5
5
 
6
6
  set_id_name "target_tags"
7
7
 
8
- class URI < IControl::Base::Struct; end ##
8
+ class URI < IControl::Base::Struct; end
9
+ class URISequence < IControl::Base::Sequence ; end ##
9
10
  # Gets the version information for this interface.
11
+ # @rspec_example
10
12
  # @return [String]
11
13
  def version
12
14
  super
@@ -14,20 +16,22 @@ module IControl::System
14
16
 
15
17
  ##
16
18
  # Returns a sequence of URIs given a list of tags.
19
+ # @rspec_example
17
20
  # @return [URI]
18
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
19
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
20
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
21
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
22
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
23
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
21
24
  def map_uri
22
25
  super
23
26
  end
24
27
 
25
28
  ##
26
29
  # Tests a connection from the device to the caller
30
+ # @rspec_example
27
31
  # @return [boolean]
28
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
29
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
30
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
31
35
  # @param [Hash] opts
32
36
  # @option opts [String] :addresses Addresses to test
33
37
  # @option opts [long] :ports Ports to test
@@ -39,10 +43,10 @@ module IControl::System
39
43
  ##
40
44
  # A struct that contains a URI.
41
45
  # @attr [String] path The URI itself (the path to the desired page)
42
- # @attr [IControl::Common::KeyValue] argmap A list of key/value pairs that will allow mapping EM internal arguments to URI parameters to the page.
46
+ # @attr [IControl::Common::KeyValueSequence] argmap A list of key/value pairs that will allow mapping EM internal arguments to URI parameters to the page.
43
47
  class URI < IControl::Base::Struct
44
48
  icontrol_attribute :path, String
45
- icontrol_attribute :argmap, IControl::Common::KeyValue
49
+ icontrol_attribute :argmap, IControl::Common::KeyValueSequence
46
50
  end
47
51
 
48
52
 
@@ -1,6 +1,7 @@
1
1
  module IControl::System
2
2
  ##
3
- # The Services interface enables you to manage the various supported services on the device, such as SSHD, HTTPD, NTPD, SOD....
3
+ # The Services interface enables you to manage the various supported services on the
4
+ # device, such as SSHD, HTTPD, NTPD, SOD....
4
5
  class Services < IControl::Base
5
6
 
6
7
  set_id_name "services"
@@ -8,6 +9,9 @@ module IControl::System
8
9
  class SSHAccess < IControl::Base::Struct; end
9
10
  class SSHAccess_v2 < IControl::Base::Struct; end
10
11
  class ServiceStatus < IControl::Base::Struct; end
12
+ class ServiceActionSequence < IControl::Base::Sequence ; end
13
+ class ServiceStatusSequence < IControl::Base::Sequence ; end
14
+ class ServiceTypeSequence < IControl::Base::Sequence ; end
11
15
  # An enumeration for different service actions.
12
16
  class ServiceAction < IControl::Base::Enumeration; end
13
17
  # An enumeration for different service statuses.
@@ -15,66 +19,77 @@ module IControl::System
15
19
  # An enumeration for different services running in the system.
16
20
  class ServiceType < IControl::Base::Enumeration; end ##
17
21
  # Determines whether this service are enabled or disabled on an ITCM appliance.
22
+ # @rspec_example
18
23
  # @return [ServiceStatus]
19
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
20
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
21
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
24
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
25
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
26
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
22
27
  def all_service_statuses
23
28
  super
24
29
  end
25
30
 
26
31
  ##
27
32
  # Gets a list of all service supported on this device.
33
+ # @rspec_example
28
34
  # @return [ServiceType]
29
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
30
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
31
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
35
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
36
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
37
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
32
38
  def list
33
39
  super
34
40
  end
35
41
 
36
42
  ##
37
43
  # Gets the statuses of this service
44
+ # @rspec_example
38
45
  # @return [ServiceStatus]
39
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
40
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
41
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
46
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
47
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
48
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
42
49
  def service_status
43
50
  super
44
51
  end
45
52
 
46
53
  ##
47
- # Note: This method is deprecated; please use get_ssh_access_v2 in new applications. Gets the ssl service state and allowed addresses.
54
+ # Note: This method is deprecated; please use get_ssh_access_v2 in new applications.
55
+ # Gets the ssl service state and allowed addresses.
56
+ # @rspec_example
48
57
  # @return [SSHAccess]
49
- # @raise [IControl::Common::AccessDenied]
50
- # @raise [IControl::Common::InvalidArgument]
51
- # @raise [IControl::Common::OperationFailed]
58
+ # @raise [IControl::IControl::Common::AccessDenied]
59
+ # @raise [IControl::IControl::Common::InvalidArgument]
60
+ # @raise [IControl::IControl::Common::OperationFailed]
52
61
  def ssh_access
53
62
  super
54
63
  end
55
64
 
56
65
  ##
57
66
  # Gets the ssl service state and allowed addresses.
67
+ # @rspec_example
58
68
  # @return [SSHAccess_v2]
59
- # @raise [IControl::Common::AccessDenied]
60
- # @raise [IControl::Common::InvalidArgument]
61
- # @raise [IControl::Common::OperationFailed]
69
+ # @raise [IControl::IControl::Common::AccessDenied]
70
+ # @raise [IControl::IControl::Common::InvalidArgument]
71
+ # @raise [IControl::IControl::Common::OperationFailed]
62
72
  def ssh_access_v2
63
73
  super
64
74
  end
65
75
 
66
76
  ##
67
77
  # Gets the version information for this interface.
78
+ # @rspec_example
68
79
  # @return [String]
69
80
  def version
70
81
  super
71
82
  end
72
83
 
73
84
  ##
74
- # Reboots the system. This method will reboot the system within specified number of seconds. Once this method has been called, no further operations or requests should be sent to the Portal, and make sure all pending operations are completed before the reboot.
75
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
76
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
77
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
85
+ # Reboots the system. This method will reboot the system within specified number of
86
+ # seconds. Once this method has been called, no further operations or requests should
87
+ # be sent to the Portal, and make sure all pending operations are completed before
88
+ # the reboot.
89
+ # @rspec_example
90
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
91
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
92
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
78
93
  # @param [Hash] opts
79
94
  # @option opts [long] :seconds_to_reboot The number of seconds before the reboot takes place.
80
95
  def reboot_system(opts)
@@ -83,10 +98,14 @@ module IControl::System
83
98
  end
84
99
 
85
100
  ##
86
- # Sets the action for all service to take. This method is asynchronous, meaning that the method may return before the requested action is completed. NOTE: For this method, the only valid values for service_action are: SERVICE_ACTION_START SERVICE_ACTION_STOP SERVICE_ACTION_REINIT SERVICE_ACTION_RESTART
87
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
88
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
89
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
101
+ # Sets the action for all service to take. This method is asynchronous, meaning that
102
+ # the method may return before the requested action is completed. NOTE: For this method,
103
+ # the only valid values for service_action are: SERVICE_ACTION_START SERVICE_ACTION_STOP
104
+ # SERVICE_ACTION_REINIT SERVICE_ACTION_RESTART
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.
90
109
  # @param [Hash] opts
91
110
  # @option opts [IControl::System::Services::ServiceAction] :service_action The action for the services to take.
92
111
  def set_all_services(opts)
@@ -95,10 +114,12 @@ module IControl::System
95
114
  end
96
115
 
97
116
  ##
98
- # Sets the action for this service to take. This method is asynchronous, meaning that the method may return before the requested action is completed.
99
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
100
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
101
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
117
+ # Sets the action for this service to take. This method is asynchronous, meaning that
118
+ # the method may return before the requested action is completed.
119
+ # @rspec_example
120
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
121
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
122
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
102
123
  # @param [Hash] opts
103
124
  # @option opts [IControl::System::Services::ServiceAction] :service_action The action for the services to take.
104
125
  def set_service(opts)
@@ -107,10 +128,12 @@ module IControl::System
107
128
  end
108
129
 
109
130
  ##
110
- # Note: This method is deprecated; please use get_ssh_access_v2 in new applications. Sets the ssl service state and allowed addresses.
111
- # @raise [IControl::Common::AccessDenied]
112
- # @raise [IControl::Common::InvalidArgument]
113
- # @raise [IControl::Common::OperationFailed]
131
+ # Note: This method is deprecated; please use get_ssh_access_v2 in new applications.
132
+ # Sets the ssl service state and allowed addresses.
133
+ # @rspec_example
134
+ # @raise [IControl::IControl::Common::AccessDenied]
135
+ # @raise [IControl::IControl::Common::InvalidArgument]
136
+ # @raise [IControl::IControl::Common::OperationFailed]
114
137
  # @param [Hash] opts
115
138
  # @option opts [IControl::System::Services::SSHAccess] :access Access structure indicating enable/disable state of the SSH service and an address range allowed to access the device via ssh.
116
139
  def set_ssh_access(opts)
@@ -120,9 +143,10 @@ module IControl::System
120
143
 
121
144
  ##
122
145
  # Sets the ssl service state and allowed addresses.
123
- # @raise [IControl::Common::AccessDenied]
124
- # @raise [IControl::Common::InvalidArgument]
125
- # @raise [IControl::Common::OperationFailed]
146
+ # @rspec_example
147
+ # @raise [IControl::IControl::Common::AccessDenied]
148
+ # @raise [IControl::IControl::Common::InvalidArgument]
149
+ # @raise [IControl::IControl::Common::OperationFailed]
126
150
  # @param [Hash] opts
127
151
  # @option opts [IControl::System::Services::SSHAccess_v2] :access Access structure indicating enable/disable state of the SSH service and an address range allowed to access the device via ssh.
128
152
  def set_ssh_access_v2(opts)
@@ -131,21 +155,30 @@ module IControl::System
131
155
  end
132
156
 
133
157
  ##
134
- # Note: This structure is deprecated; please use SSHAccess_v2 in new applications. A struct that contains information about SSH state and access settings Note: as of v9.4.2, we have added &amp;quot;NONE" to this interface; as an address it means no access. Also please note that this interface has represented and still represents ALL access as &amp;quot;::". On the BIG-IP itself (as shown in the GUI, CLI, and db variables, v9.4.2 changed &amp;quot;::" to mean no access (returned here as NONE), and the word &amp;quot;ALL" means all access (still returned with this interface as &amp;quot;::").
158
+ # Note: This structure is deprecated; please use SSHAccess_v2 in new applications.
159
+ # A struct that contains information about SSH state and access settings Note: as of
160
+ # v9.4.2, we have added &amp;quot;NONE" to this interface; as an address it means no
161
+ # access. Also please note that this interface has represented and still represents
162
+ # ALL access as &amp;quot;::". On the BIG-IP itself (as shown in the GUI, CLI, and
163
+ # db variables, v9.4.2 changed &amp;quot;::" to mean no access (returned here as NONE),
164
+ # and the word &amp;quot;ALL" means all access (still returned with this interface
165
+ # as &amp;quot;::").
135
166
  # @attr [IControl::Common::EnabledState] state The state of the service, either 'enable' or 'disable'
136
- # @attr [String] addresses The addresses and address ranges allowed to access the device via SSH
167
+ # @attr [StringSequence] addresses The addresses and address ranges allowed to access the device via SSH
137
168
  class SSHAccess < IControl::Base::Struct
138
169
  icontrol_attribute :state, IControl::Common::EnabledState
139
- icontrol_attribute :addresses, String
170
+ icontrol_attribute :addresses, StringSequence
140
171
  end
141
172
 
142
173
  ##
143
- # A struct that contains information about SSH state and access settings Note: In addresses, &amp;quot;::" means no access, and &amp;quot;ALL" means all access. The semantics for no access and all access are different than the previous SSHAccess interface.
174
+ # A struct that contains information about SSH state and access settings Note: In addresses,
175
+ # &amp;quot;::" means no access, and &amp;quot;ALL" means all access. The semantics
176
+ # for no access and all access are different than the previous SSHAccess interface.
144
177
  # @attr [IControl::Common::EnabledState] state The state of the service, either 'enable' or 'disable'
145
- # @attr [String] addresses The addresses and address ranges allowed to access the device via SSH
178
+ # @attr [StringSequence] addresses The addresses and address ranges allowed to access the device via SSH
146
179
  class SSHAccess_v2 < IControl::Base::Struct
147
180
  icontrol_attribute :state, IControl::Common::EnabledState
148
- icontrol_attribute :addresses, String
181
+ icontrol_attribute :addresses, StringSequence
149
182
  end
150
183
 
151
184
  ##