APIRef_tm_sys_serviceΒΆ
mgmt/tm/sys/service
Controls the BIG-IP system services.
REST Endpoints
- Collection URI
/mgmt/tm/sys/service- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/sys/service/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, POST- Resource Natural Key
name
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
add |
boolean | optional | read/write | Specifies to add a service so that the service starts at boot time, or with the default service set. | |
appService |
string | optional | read/write | ||
disable |
boolean | optional | read/write | Specifies to manually disable the services. After you disable services, you must enable, and then start the services before the services run again. | |
enable |
boolean | optional | read/write | Specifies to enable the services. Please note that disabled services do not run until you enable, and then start the services again. | |
force |
boolean | optional | read/write | Ends the services. Use this option as a last resort when services do not terminate automatically. Note that this option does not operate on the default set of services, you must specify the services that you want to end. | |
memstat |
boolean | optional | read | Provides a status on the pre-set memory limit of the services and how much memory each service is currently using. | |
reinit |
boolean | optional | read/write | Specifies to reinitialize the services or re-read the config files for the services. You must specify the services that you want to reinitialize. | |
remove |
boolean | optional | read/write | Specifies to remove a service so that the service does not start at boot time or with the default service set. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/sys-service-id |
array_structure | optional | read | ||
/sys-service-id/app-service |
string | optional | read/write | ||
/sys-service-id/boot |
string | optional | read/write | ||
/sys-service-id/default |
string | optional | read/write |
Copyright (c) 2016, 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.