APIRef_tm_sys_global-settings¶
mgmt/tm/sys/global-settings
General system settings
REST Endpoints
- Collection URI
/mgmt/tm/sys/global-settings- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/sys/global-settings/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
awsAccessKey |
string | optional | read/write | Amazon Web Service(AWS) supplied access key needed to make secure requests to AWS. | |
awsApiMaxConcurrency |
integer | 1 | optional | read/write | Maximum concurrent connections allowed while making Amazon Web Service(AWS) api calls. |
awsSecretKey |
string | optional | read/write | Amazon Web Service(AWS) supplied secret key needed to make secure requests to AWS. | |
consoleInactivityTimeout |
integer | optional | read/write | Specifies the number of seconds of inactivity before the system logs off a user that is logged on. The default value is 0. This means that no timeout is set. | |
customAddr |
string | optional | read/write | Indicates a user-specified IP address for the system. The default value is none. It is important to note that you must set the host-addr-mode option to custom, if you want to specify an IP address using custom addr. For more information, see the host-addr-mode option, below. | |
description |
string | optional | read/write | User defined description. | |
failsafeAction |
string | optional | read/write | Specifies the action that the system takes when the switch board fails. The default value is go offline abort tm. | |
fileBlacklistPathPrefix |
string | optional | read/write | Specifies the path prefixes that are disallowed for certain commands. It is used by the tmsh save/load sys config file command to disallow saving or loading configuration. The paths are specified in braces separated by spaces in quotes. ex: “{/shared/3dns/} {/shared/bin/}”. | |
fileBlacklistReadOnlyPathPrefix |
string | optional | read/write | Specifies the read-only path prefixes that are disallowed for certain commands. It is used by the tmsh save/load sys config file command to disallow saving or loading configuration. It is a read-only attribute with value “{/etc/shadow}”. | |
fileLocalPathPrefix |
string | optional | read/write | Specifies a list of folder prefixes that can be applied for file objects. This is a space separated list of folder prefixes, contained in curly braces. Example: “{file:///shared/}” or “{file:///file/object/folder/} {/shared/}”. By default the folders are “/shared/” and “/tmp/”, represented as “{/shared/} {/tmp/}”. | |
fileWhitelistPathPrefix |
string | optional | read/write | Specifies the path prefixes that are valid for certain commands. It is used by the tmsh save/load sys config file command for saving or loading configuration. The paths are specified in braces separated by spaces in quotes. ex: “{/var/local/scf/} {/tmp/} {/shared/} {/config/}”. | |
guiSecurityBanner |
string | optional | read/write | Specifies whether or not show GUI login security banner. | |
guiSecurityBannerText |
string | optional | read/write | Specifies the text of GUI login security banner. | |
guiSetup |
string | optional | read/write | Enables or disables the Setup utility in the browser-based Configuration utility. The default value is enabled. Note that when you configure a system using the command line interface, you should disable this option. Disabling the gui setup option of the system command allows your system administrators to use the browser-based Configuration utility without having to run the Setup Utility. | |
hostAddrMode |
string | optional | read/write | Specifies the type of host address assigned to the system. The default value is mgmt, which indicates that the host address is the management port of the system. If you use the state-mirror option, then the host address of the system is shared by the other system in a redundant pair. In case of system failure, the traffic to the other system is routed to this system. If you use the custom option, you must specify a custom IP address for the system using the custom addr option. For more information, see the custom addr option, above. | |
hostname |
string | optional | read/write | Specifies a local name for the system. The default value is bigip1. | |
hostsAllowInclude |
string | optional | read/write | Warning: Do not use this parameter without assistance from the F5 Technical Support team. The system does not validate the commands issued using the include parameter. If you use this parameter incorrectly, you put the functionality of the system at risk. | |
lcdDisplay |
string | optional | read/write | Enables or disables the display on the front of the system. The default is enabled. | |
ledLocator |
string | optional | read/write | ||
mgmtDhcp |
string | enabled | optional | read/write | Specifies whether or not to enable DHCP client on the management interface. |
netReboot |
string | optional | read/write | Enables or disables the network reboot feature. The default is disabled. If you enable this feature and then reboot the system, the system boots from an ISO image on the network, rather than from an internal media drive. Use this option only when you want to install software on the system, for example, for an upgrade or a re-installation. Note that this setting reverts to disabled after you reboot the system a second time. | |
passwordPrompt |
string | optional | read/write | Specifies the text to use on the GUI login form above the field for the password. This allows you to give the user a hint as to which password to use if the BIG-IP has been configured to use an external user directory such as Active Directory or LDAP. | |
quietBoot |
string | optional | read/write | Enables or disables the quiet boot feature. The default is enabled. If you enable this feature, the system suppresses informational text on the console during the boot cycle. | |
usernamePrompt |
string | optional | read/write | Specifies the text to use on the GUI login form above the field for the username. This allows you to give the user a hint as to which username to use if the BIG-IP has been configured to use an external user directory such as Active Directory or LDAP. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/remote-host |
array_structure | optional | read/write | Configuration of remote hosts. | |
/remote-host/addr |
string | required | read/write | Specifies remote host address. | |
/remote-host/hostname |
string | required | read/write | Specifies remote host hostname. |
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.