System::Services

Introduced : BIG-IP_v9.0
The Services interface enables you to manage the various supported services on the device, such as SSHD, HTTPD, NTPD, SOD…. This interface does not support transactions.

Methods

Method Description Introduced
get_all_service_statuses Determines whether the specified services are enabled or disabled on an ITCM appliance. BIG-IP_v9.0
get_list Gets a list of all services supported on this device. BIG-IP_v9.0
get_service_status Gets the statuses of the specified services BIG-IP_v9.0
get_ssh_access Note: This method is deprecated; please use get_ssh_access_v2 in new applications. Gets the ssl service state and allowed addresses. Please see note in SSHAccess regarding “no access” and “all access”. BIG-IP_v9.4.0
get_ssh_access_v2 Gets the ssl service state and allowed addresses. Please see note in SSHAccess_v2 regarding “no access” and “all access”. BIG-IP_v9.4.2
get_version Gets the version information for this interface. BIG-IP_v9.0
reboot_system 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. BIG-IP_v9.0
set_all_services Sets the action for all services 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 BIG-IP_v9.0
set_service Sets the action for the specified services to take. This method is asynchronous, meaning that the method may return before the requested action is completed. BIG-IP_v9.0
set_ssh_access Note: This method is deprecated; please use get_ssh_access_v2 in new applications. Sets the ssl service state and allowed addresses. Please see note in SSHAccess regarding “no access” and “all access”. BIG-IP_v9.4.0
set_ssh_access_v2 Sets the ssl service state and allowed addresses. Please see note in SSHAccess_v2 regarding “no access” and “all access”. BIG-IP_v9.4.2

Structures

Structure

Description

SSHAccess

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 “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 “::”. On the BIG-IP itself (as shown in the GUI, CLI, and db variables, v9.4.2 changed “::” to mean no access (returned here as NONE), and the word “ALL” means all access (still returned with this interface as “::”).

SSHAccess_v2

A struct that contains information about SSH state and access settings Note: In addresses, “::” means no access, and “ALL” means all access. The semantics for no access and all access are different than the previous SSHAccess interface.

ServiceStatus

A struct that contains information about the status of a service.


Enumerations

Enumeration Description
ServiceAction An enumeration for different service actions.
ServiceStatusType An enumeration for different service statuses.
ServiceType An enumeration for different services running in the system.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ServiceActionSequence ServiceAction [] A sequence of service actions.
ServiceStatusSequence ServiceStatus [] A sequence of service status entries.
ServiceTypeSequence ServiceType [] A sequence of service types.

See Also

iControl ::
iControl :: System :: Services

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.