W3cubDocs

/Ansible

f5networks.f5_modules.bigip_device_info – Collect information from F5 BIG-IP devices

Note

This plugin is part of the f5networks.f5_modules collection (version 1.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_device_info.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

  • Collect information from F5 BIG-IP devices.
  • This module was called bigip_device_facts before Ansible 2.9. The usage did not change.

Parameters

Parameter Choices/Defaults Comments
gather_subset
list / elements=string / required
    Choices:
  • all
  • monitors
  • profiles
  • apm-access-profiles
  • apm-access-policies
  • as3
  • asm-policy-stats
  • asm-policies
  • asm-server-technologies
  • asm-signature-sets
  • client-ssl-profiles
  • cfe
  • devices
  • device-groups
  • do
  • external-monitors
  • fasthttp-profiles
  • fastl4-profiles
  • gateway-icmp-monitors
  • gtm-pools
  • gtm-servers
  • gtm-wide-ips
  • gtm-a-pools
  • gtm-a-wide-ips
  • gtm-aaaa-pools
  • gtm-aaaa-wide-ips
  • gtm-cname-pools
  • gtm-cname-wide-ips
  • gtm-mx-pools
  • gtm-mx-wide-ips
  • gtm-naptr-pools
  • gtm-naptr-wide-ips
  • gtm-srv-pools
  • gtm-srv-wide-ips
  • gtm-topology-regions
  • http-monitors
  • https-monitors
  • http-profiles
  • iapp-services
  • iapplx-packages
  • icmp-monitors
  • interfaces
  • internal-data-groups
  • irules
  • ltm-pools
  • ltm-policies
  • management-routes
  • nodes
  • oneconnect-profiles
  • partitions
  • provision-info
  • remote-syslog
  • route-domains
  • self-ips
  • server-ssl-profiles
  • software-volumes
  • software-images
  • software-hotfixes
  • ssl-certs
  • ssl-keys
  • sync-status
  • system-db
  • system-info
  • ts
  • tcp-monitors
  • tcp-half-open-monitors
  • tcp-profiles
  • traffic-groups
  • trunks
  • udp-profiles
  • users
  • vcmp-guests
  • virtual-addresses
  • virtual-servers
  • vlans
  • !all
  • !as3
  • !do
  • !ts
  • !cfe
  • !monitors
  • !profiles
  • !apm-access-profiles
  • !apm-access-policies
  • !asm-policy-stats
  • !asm-policies
  • !asm-server-technologies
  • !asm-signature-sets
  • !client-ssl-profiles
  • !devices
  • !device-groups
  • !external-monitors
  • !fasthttp-profiles
  • !fastl4-profiles
  • !gateway-icmp-monitors
  • !gtm-pools
  • !gtm-servers
  • !gtm-wide-ips
  • !gtm-a-pools
  • !gtm-a-wide-ips
  • !gtm-aaaa-pools
  • !gtm-aaaa-wide-ips
  • !gtm-cname-pools
  • !gtm-cname-wide-ips
  • !gtm-mx-pools
  • !gtm-mx-wide-ips
  • !gtm-naptr-pools
  • !gtm-naptr-wide-ips
  • !gtm-srv-pools
  • !gtm-srv-wide-ips
  • !gtm-topology-regions
  • !http-monitors
  • !https-monitors
  • !http-profiles
  • !iapp-services
  • !iapplx-packages
  • !icmp-monitors
  • !interfaces
  • !internal-data-groups
  • !irules
  • !ltm-pools
  • !ltm-policies
  • !management-routes
  • !nodes
  • !oneconnect-profiles
  • !partitions
  • !provision-info
  • !remote-syslog
  • !route-domains
  • !self-ips
  • !server-ssl-profiles
  • !software-volumes
  • !software-images
  • !software-hotfixes
  • !ssl-certs
  • !ssl-keys
  • !sync-status
  • !system-db
  • !system-info
  • !tcp-monitors
  • !tcp-half-open-monitors
  • !tcp-profiles
  • !traffic-groups
  • !trunks
  • !udp-profiles
  • !users
  • !vcmp-guests
  • !virtual-addresses
  • !virtual-servers
  • !vlans
When supplied, this argument will restrict the information returned to a given subset.
You can specify a list of values to include a larger subset.
Values can also be used with an initial ! to specify that a specific subset should not be collected.

aliases: include
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
A dict object containing connection details.
auth_provider
string
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
no_f5_teem
boolean
    Choices:
  • no ←
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TELEMETRY_OFF.
Previously used variable F5_TEEM is deprecated as its name was confusing.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
integer
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
timeout
integer
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
transport
string
    Choices:
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS.

Notes

Note

  • For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
  • Requires BIG-IP software version >= 12.
  • The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- name: Collect BIG-IP information
  bigip_device_info:
    gather_subset:
      - interfaces
      - vlans
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Collect all BIG-IP information
  bigip_device_info:
    gather_subset:
      - all
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Collect all BIG-IP information except trunks
  bigip_device_info:
    gather_subset:
      - all
      - "!trunks"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
apm_access_policies
complex
When apm-access-policies is specified in gather_subset.
Information about APM Access Policies.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/foo_policy
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
foo_policy
apm_access_profiles
complex
When apm-access-profiles is specified in gather_subset.
Information about APM Access Profiles.
access_policy
string
queried
APM Access Policy attached to this Access Profile.

Sample:
foo_policy
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/foo_policy
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
foo_policy
asm_policies
complex
When asm-policies is specified in gather_subset.
Detailed information for ASM policies present on device.

Sample:
hash/dictionary of values
active
boolean
queried
Indicates if an ASM policy is active. In TMOS 13.x and above, this setting indicates if the policy is bound to any Virtual Server.

Sample:
True
allowed_response_codes
list / elements=string
queried
Lists the response status codes between 400 and 599 that the security profile considers legal.

Sample:
['400', '404']
application_language
string
queried
The language encoding for the web application.

Sample:
utf-8
apply
boolean
queried
In TMOS 13.x and above, this setting indicates if an ASM policy has pending changes that need to be applied.

Sample:
True
case_insensitive
boolean
queried
Indicates if the ASM policy treats file types, URLs, and parameters as case sensitive.

Sample:
True
csrf_protection_enabled
boolean
queried
Specifies if CSRF protection is active on the ASM policy.

Sample:
True
csrf_protection_expiration_time_in_seconds
integer
queried
Specifies how long, in seconds, a configured CSRF token is valid before it expires.

Sample:
600
csrf_protection_ssl_only
boolean
queried
Specifies that only HTTPS URLs will be checked for CSRF protection.

Sample:
True
csrf_urls
complex
queried
Specifies a list of URLs for CSRF token verification.
In version 13.0.0 and later, this has become a sub-collection and a list of dictionaries.
In version 12.x, this is a list of simple strings.
csrf_url
string
queried
Specifies an URL to protect.

Sample:
['/foo.html']
csrf_url_enforcement_action
string
queried
Indicates the action specified for the system to take when the URL entry matches.

Sample:
none
csrf_url_id
string
queried
Specifies the generated ID for the configured CSRF URL resource.

Sample:
l0Ckxe-7yHsXp8U5tTgbFQ
csrf_url_method
string
queried
Method for the specified URL.

Sample:
POST
csrf_url_parameters_list
list / elements=string
queried
List of parameters to look for in a request when checking if the URL entry matches the request.

Sample:
['fooparam']
csrf_url_required_parameters
string
queried
Indicates whether to ignore or require one of the specified parameters is present in a request when checking if the URL entry matches the request.

Sample:
ignore
csrf_url_wildcard_order
string
queried
Specifies the order in which the wildcard URLs are enforced.

Sample:
1
custom_xff_headers
string
queried
List of custom XFF headers trusted by the system.

Sample:
asm-proxy1
description
string
queried
Description of the resource.

Sample:
Significant Policy Description
disallowed_geolocations
string
queried
Displays countries that may not access the web application.

Sample:
Argentina
enforcement_mode
string
queried
Specifies whether blocking is active or inactive for the ASM policy.

Sample:
blocking
enforcement_readiness_period
integer
queried
Period in days both security policy entities and attack signatures remain in staging mode before the system suggests to enforce them.

Sample:
8
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/foo_policy
has_parent
boolean
queried
Indicates if the ASM policy is a child of another ASM policy.
inspect_http_uploads
boolean
queried
Specifies whether the system should inspect all HTTP uploads.

Sample:
True
learning_mode
string
queried
Determine how the policy is built.

Sample:
manual
manual_virtual_servers
list / elements=string
queried
The virtual servers that have Advanced LTM policy configuration which, in turn, have rule(s) built with ASM control actions enabled.

Sample:
['/Common/test_VS/']
mask_credit_card_numbers_in_request
boolean
queried
Indicates if the system masks credit card numbers.
maximum_cookie_header_length
integer
queried
Maximum length of a cookie header name and value that the system processes.

Sample:
8192
maximum_http_header_length
integer
queried
Maximum length of an HTTP header name and value that the system processes.

Sample:
8192
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
foo_policy
path_parameter_handling
string
queried
Specifies how the system handles path parameters that are attached to path segments in URIs.

Sample:
ignore
place_signatures_in_staging
boolean
queried
Specifies if the system places new or updated signatures in staging for the number of days specified in the enforcement readiness period.
policy_id
string
queried
Generated ID of the ASM policy resource.

Sample:
l0Ckxe-7yHsXp8U5tTgbFQ
protocol_independent
boolean
queried
Indicates if the ASM policy differentiates between HTTP/WS and HTTPS/WSS URLs.
signature_staging
boolean
queried
Specifies if the staging feature is active on the ASM policy.

Sample:
True
trigger_asm_irule_event
string
queried
Indicates if iRule event is enabled.

Sample:
disabled
trust_xff
boolean
queried
Indicates the system has confidence in an XFF (X-Forwarded-For) header in the request.

Sample:
True
type
string
queried
The type of policy, can be Security or Parent.

Sample:
security
use_dynamic_session_id_in_url
boolean
queried
Specifies how the security policy processes URLs that use dynamic sessions.
virtual_servers
list / elements=string
queried
Virtual server or servers which have this policy assigned to them.

Sample:
['/Common/foo_VS/']
asm_policy_stats
complex
When asm-policy-stats is specified in gather_subset.
Miscellaneous ASM policy related information.

Sample:
hash/dictionary of values
parent_policies
integer
queried
The total number of ASM parent policies on the device.

Sample:
2
policies
integer
queried
The total number of ASM policies on the device.

Sample:
3
policies_active
integer
queried
The number of ASM policies that are marked as active. From TMOS 13.x and above this setting equals to policies_attached.

Sample:
3
policies_attached
integer
queried
The number of ASM policies that are attached to virtual servers.

Sample:
1
policies_inactive
integer
queried
The number of ASM policies that are marked as inactive. From TMOS 13.x and above this setting equals to policies_unattached.
policies_pending_changes
integer
queried
The total number of ASM policies with pending changes on the device.

Sample:
2
policies_unattached
integer
queried
The number of ASM policies that are not attached to a virtual server.

Sample:
3
asm_server_technologies
complex
When asm-server-technologies is specified in gather_subset.
Detailed information for ASM server technologies present on the device.

Sample:
hash/dictionary of values
id
string
queried
Displays the generated ID for the server technology resource.

Sample:
l0Ckxe-7yHsXp8U5tTgbFQ
server_technology_name
string
queried
Friendly name of the server technology resource.

Sample:
Wordpress
server_technology_references
complex
queried
List of dictionaries containing API self links of the associated technology resources.
link
string
queried
A self link to an associated server technology.

Sample:
https://localhost/mgmt/tm/asm/server-technologies/NQG7CT02OBC2cQWbnP7T-A?ver=13.1.0
asm_signature_sets
complex
When asm-signature-sets is specified in gather_subset.
Detailed information for ASM signature sets present on device.

Sample:
hash/dictionary of values
assign_to_policy_by_default
boolean
queried
Indicates whether the system assigns this signature set to a new created security policy by default.

Sample:
True
category
string
queried
Displays the category of the signature set.

Sample:
filter-based
default_alarm
boolean
queried
Displays whether the security policy logs the request data in the Statistics screen if a request matches a signature that is included in the signature set.

Sample:
True
default_block
boolean
queried
When the security policy enforcement mode is Blocking, displays how the system treats requests that match a signature included in the signature set.

Sample:
True
default_learn
boolean
queried
Displays whether the security policy learns all requests that match a signature that is included in the signature set.

Sample:
True
id
string
queried
Displays the generated ID for the signature set resource.

Sample:
l0Ckxe-7yHsXp8U5tTgbFQ
is_user_defined
boolean
queried
Specifies this signature set was added by a user.
name
string
queried
Name of the signature set.

Sample:
WebSphere signatures
type
string
queried
The method used to select signatures to be a part of the signature set.

Sample:
filter-based
client_ssl_profiles
complex
When client-ssl-profiles is specified in gather_subset.
Client SSL Profile related information.

Sample:
hash/dictionary of values
alert_timeout
integer
queried
Maximum time period, in seconds, to keep the SSL session active after an alert message is sent, or indefinite.
allow_non_ssl
boolean
queried
Enables or disables non-SSL connections.

Sample:
True
authenticate_depth
integer
queried
Specifies the authenticate depth. This is the client certificate chain maximum traversal depth.

Sample:
9
authenticate_frequency
string
queried
Specifies how often the system authenticates a user.

Sample:
once
ca_file
string
queried
Specifies the certificate authority (CA) file name.

Sample:
/Common/default-ca.crt
cache_size
integer
queried
Specifies the SSL session cache size.

Sample:
262144
cache_timeout
integer
queried
Specifies the SSL session cache timeout value.

Sample:
3600
certificate_file
string
queried
Specifies the name of the certificate installed on the traffic management system for the purpose of terminating or initiating an SSL connection.

Sample:
/Common/default.crt
chain_file
string
queried
Specifies or builds a certificate chain file that a client can use to authenticate the profile.

Sample:
/Common/ca-chain.crt
ciphers
string
queried
Specifies a list of cipher names.

Sample:
['DEFAULT']
crl_file
string
queried
Specifies the certificate revocation list file name.

Sample:
/Common/default.crl
description
string
queried
Description of the profile.

Sample:
My profile
forward_proxy_ca_certificate_file
string
queried
Specifies the name of the certificate file that is used as the certification authority certificate when SSL forward proxy feature is enabled.
forward_proxy_ca_key_file
string
queried
Specifies the name of the key file that is used as the certification authority key when SSL forward proxy feature is enabled.
forward_proxy_ca_passphrase
string
queried
Specifies the passphrase of the key file that is used as the certification authority key when SSL forward proxy feature is enabled.
forward_proxy_certificate_extension_include
list / elements=string
queried
Specifies the extensions of the web server certificates to be included in the generated certificates using SSL Forward Proxy.

Sample:
['basic-constraints', 'subject-alternative-name']
forward_proxy_certificate_lifespan
integer
queried
Specifies the lifespan of the certificate generated using the SSL forward proxy feature.

Sample:
30
forward_proxy_enabled
boolean
queried
Enables or disables SSL forward proxy feature.

Sample:
True
forward_proxy_lookup_by_ipaddr_port
boolean
queried
Specifies whether to perform certificate look up by IP address and port number.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/bigip02.internal
handshake_timeout
integer
queried
Specifies the handshake timeout in seconds.

Sample:
10
key_file
string
queried
Specifies the name of the key installed on the traffic management system for the purpose of terminating or initiating an SSL connection.

Sample:
/Common/default.key
modssl_methods
boolean
queried
Enables or disables ModSSL method emulation.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
bigip02.internal
parent
string
queried
Parent of the profile

Sample:
/Common/clientssl
peer_certification_mode
string
queried
Specifies the peer certificate mode.

Sample:
ignore
profile_mode_enabled
boolean
queried
Specifies the profile mode, which enables or disables SSL processing.

Sample:
True
renegotiation
boolean
queried
Specifies whether renegotiations are enabled.

Sample:
True
renegotiation_maximum_record_delay
integer
queried
Maximum number of SSL records that the traffic management system can receive before it renegotiates an SSL session.
renegotiation_period
integer
queried
Number of seconds required to renegotiate an SSL session.
retain_certificate
boolean
queried
APM module requires storing certificate in SSL session. When no, certificate will not be stored in SSL session.

Sample:
True
secure_renegotiation_mode
string
queried
Specifies the secure renegotiation mode.

Sample:
require
server_name
string
queried
Specifies the server names to be matched with SNI (server name indication) extension information in ClientHello from a client connection.

Sample:
bigip01
session_ticket
boolean
queried
Enables or disables session-ticket.
sni_default
boolean
queried
When yes, this profile is the default SSL profile when the server name in a client connection does not match any configured server names, or a client connection does not specify any server name at all.

Sample:
True
sni_require
boolean
queried
When this option is yes, a client connection that does not specify a known server name or does not support SNI extension will be rejected.
strict_resume
boolean
queried
Enables or disables strict-resume.

Sample:
True
unclean_shutdown
boolean
queried
Whether to force the SSL profile to perform a clean shutdown of all SSL connections or not
device_groups
complex
When device-groups is specified in gather_subset.
Device group related information.

Sample:
hash/dictionary of values
asm_sync_enabled
boolean
queried
Specifies whether to synchronize ASM configurations of device group members.

Sample:
True
autosync_enabled
boolean
queried
Whether the device group automatically synchronizes configuration data to its members.
description
string
queried
Description of the device group.

Sample:
My device group
devices
list / elements=string
queried
List of devices in the group. Devices are listed by their full_path.

Sample:
['/Common/bigip02.internal']
full_load_on_sync
boolean
queried
Specifies the entire configuration for a device group is sent when configuration synchronization is performed.

Sample:
True
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/fasthttp
incremental_config_sync_size_maximum
integer
queried
Specifies the maximum size (in KB) to devote to incremental config sync cached transactions.

Sample:
1024
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
fasthttp
network_failover_enabled
boolean
queried
Specifies whether network failover is used.

Sample:
True
type
string
queried
Specifies the type of device group.

Sample:
sync-only
devices
complex
When devices is specified in gather_subset.
Device related information.

Sample:
hash/dictionary of values
active_modules
list / elements=string
queried
The currently licensed and provisioned modules on the device.

Sample:
['DNS Services (LAB)', 'PSM, VE']
base_mac_address
string
queried
Media Access Control address (MAC address) of the device.

Sample:
fa:16:3e:c3:42:6f
build
string
queried
The minor version information of the total product version.

Sample:
0.0.1
chassis_id
string
queried
Serial number of the device.

Sample:
11111111-2222-3333-444444444444
chassis_type
string
queried
Displays the chassis type. The possible values are individual and viprion.

Sample:
individual
comment
string
queried
User comments about the device.

Sample:
My device
configsync_address
string
queried
IP address used for configuration synchronization.

Sample:
10.10.10.10
contact
string
queried
Administrator contact information.

Sample:
The User
description
string
queried
Description of the device.

Sample:
My device
edition
string
queried
Displays the software edition.

Sample:
Point Release 7
failover_state
string
queried
Device failover state.

Sample:
active
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/bigip02.internal
hostname
string
queried
Device hostname

Sample:
bigip02.internal
location
string
queried
Specifies the physical location of the device.

Sample:
London
management_address
string
queried
IP address of the management interface.

Sample:
3.3.3.3
marketing_name
string
queried
Marketing name of the device platform.

Sample:
BIG-IP Virtual Edition
multicast_address
string
queried
Specifies the multicast IP address used for failover.

Sample:
4.4.4.4
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
bigip02.internal
optional_modules
list / elements=string
queried
Modules that are available for the current platform, but are not currently licensed.

Sample:
['App Mode (TMSH Only, No Root/Bash)', 'BIG-IP VE, Multicast Routing']
platform_id
string
queried
Displays the device platform identifier.

Sample:
Z100
primary_mirror_address
string
queried
Specifies the IP address used for state mirroring.

Sample:
5.5.5.5
product
string
queried
Displays the software product name.

Sample:
BIG-IP
secondary_mirror_address
string
queried
Secondary IP address used for state mirroring.

Sample:
2.2.2.2
self
boolean
queried
Whether or not this device is the one that was queried for information.

Sample:
True
software_version
string
queried
Displays the software version number.

Sample:
13.1.0.7
timelimited_modules
list / elements=string
queried
Displays the licensed modules that are time-limited.

Sample:
['IP Intelligence, 3Yr, ...', 'PEM URL Filtering, 3Yr, ...']
timezone
string
queried
Displays the time zone configured on the device.

Sample:
UTC
unicast_addresses
complex
queried
Specifies the entire set of unicast addresses used for failover.
effective_ip
string
queried
The IP address that peers can use to reach this unicast address IP.

Sample:
5.4.3.5
effective_port
integer
queried
The port that peers can use to reach this unicast address.

Sample:
1026
ip
string
queried
The IP address the failover daemon will listen on for packets from its peers.

Sample:
5.4.3.5
port
integer
queried
The IP port the failover daemon uses to accept packets from its peers.

Sample:
1026
external_monitors
complex
When external-monitors is specified in gather_subset.
External monitor related information.

Sample:
hash/dictionary of values
args
string
queried
Specifies any command-line arguments the script requires.

Sample:
arg1 arg2 arg3
description
string
queried
Description of the resource.

Sample:
My monitor
destination
string
queried
Specifies the IP address and service port of the resource that is the destination of this monitor.

Sample:
*:*
external_program
string
queried
Specifies the name of the file for the monitor to use.

Sample:
/Common/arg_example
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/external
interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

Sample:
5
manual_resume
boolean
queried
Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
external
parent
string
queried
Profile from which this profile inherits settings.

Sample:
external
time_until_up
integer
queried
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
timeout
integer
queried
Specifies the number of seconds the target has in which to respond to the monitor request.

Sample:
16
up_interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up.
variables
dictionary
success
Specifies any variables the script requires.

Sample:
{'key1': 'val', 'key_2': 'val 2'}
fasthttp_profiles
complex
When fasthttp-profiles is specified in gather_subset.
FastHTTP profile related information.

Sample:
hash/dictionary of values
client_close_timeout
integer
queried
Number of seconds after which the system closes a client connection, when the system either receives a client FIN packet or sends a FIN packet to the client.

Sample:
5
description
string
queried
Description of the resource.

Sample:
My profile
force_http_1_0_response
boolean
queried
When yes, specifies the server sends responses to clients in the HTTP/1.0 format.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/fasthttp
http_1_1_close_workarounds
boolean
queried
When yes, specifies the server uses workarounds for HTTP 1.1 close issues.
idle_timeout
integer
queried
Length of time that a connection is idle (has no traffic) before the connection is eligible for deletion.

Sample:
300
insert_xforwarded_for
boolean
queried
Whether the system inserts the X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling.
maximum_header_size
integer
queried
Maximum amount of HTTP header data the system buffers before making a load balancing decision.

Sample:
32768
maximum_requests
integer
queried
Maximum number of requests the system can receive on a client-side connection, before the system closes the connection.
maximum_segment_size_override
integer
queried
Maximum segment size (MSS) override for server-side connections.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
fasthttp
oneconnect_idle_timeout_override
integer
queried
Number of seconds after which a server-side connection in a OneConnect pool is eligible for deletion, when the connection has no traffic.
oneconnect_maximum_pool_size
integer
queried
Maximum number of connections to a load balancing pool.

Sample:
2048
oneconnect_maximum_reuse
integer
queried
Maximum number of times the system can re-use a current connection.
oneconnect_minimum_pool_size
integer
queried
Minimum number of connections to a load balancing pool.
oneconnect_ramp_up_increment
integer
queried
The increment in which the system makes additional connections available, when all available connections are in use.

Sample:
4
oneconnect_replenish'
boolean
queried
When yes, specifies the system will not keep a steady-state maximum of connections to the back-end, unless the number of connections to the pool have dropped beneath the minimum_pool_size specified in the profile.

Sample:
True
parent
string
queried
Profile from which this profile inherits settings.

Sample:
fasthttp
receive_window_size
integer
queried
Amount of data the BIG-IP system can accept without acknowledging the server.
request_header_insert
string
queried
A string the system inserts as a header in an HTTP request. If the header already exists, the system does not replace it.

Sample:
X-F5-Authentication: foo
reset_on_timeout
boolean
queried
When yes, specifies the system sends a reset packet (RST) in addition to deleting the connection, when a connection exceeds the idle timeout value.

Sample:
True
server_close_timeout
integer
queried
Number of seconds after which the system closes a client connection, when the system either receives a server FIN packet or sends a FIN packet to the server.

Sample:
5
server_sack
boolean
queried
Whether the BIG-IP system processes Selective ACK (Sack) packets in cookie responses from the server.
server_timestamp
boolean
queried
Whether the BIG-IP system processes timestamp request packets in cookie responses from the server.
unclean_shutdown
string
queried
How the system handles closing connections. Values provided may be enabled, disabled, or fast.

Sample:
enabled
fastl4_profiles
complex
When fastl4-profiles is specified in gather_subset.
FastL4 profile related information.

Sample:
hash/dictionary of values
client_timeout
integer
queried
Specifies late binding client timeout in seconds.
This is the number of seconds allowed for a client to transmit enough data to select a server pool.
If this timeout expires, the timeout-recovery option dictates whether to drop the connection or fallback to the normal FastL4 load balancing method to pick a server pool.

Sample:
30
description
string
queried
Description of the resource.

Sample:
My profile
dont_fragment_flag
string
queried
Describes the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet.
When pmtu, sets the outgoing IP Header DF bit based on the IP pmtu setting(tm.pathmtudiscovery).
When preserve, sets the outgoing packet's IP Header DF bit to be the same as the incoming IP Header DF bit.
When set, sets the outgoing packet's IP Header DF bit.
When clear, clears the outgoing packet's IP Header DF bit.

Sample:
pmtu
explicit_flow_migration
boolean
queried
Specifies whether to have the iRule code determine exactly when the FIX stream drops down to the ePVA hardware.

Sample:
True
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/fastl4
generate_init_seq_number
boolean
queried
Specifies whether you want to generate TCP sequence numbers on all SYNs that conform with RFC1948, and allow timestamp recycling.

Sample:
True
hardware_syn_cookie
boolean
queried
Enables or disables hardware SYN cookie support when PVA10 is present on the system.
This option is deprecated in version 13.0.0 and is replaced by syn-cookie-enable.
idle_timeout
integer
queried
Specifies the number of seconds a connection is idle before the connection is eligible for deletion.
Values are in the range of 0 to 4294967295 (inclusive).
0 is equivalent to the TMUI value "immediate".
4294967295 is equivalent to the TMUI value "indefinite".

Sample:
300
ip_tos_to_client
string
queried
Specifies an IP Type of Service (ToS) number for the client-side.
This option specifies the ToS level the traffic management system assigns to IP packets when sending them to clients.

Sample:
200
ip_tos_to_server
string
queried
Specifies an IP ToS number for the server side.
This option specifies the ToS level the traffic management system assigns to IP packets when sending them to servers.

Sample:
pass-through
keep_alive_interval
integer
queried
Specifies the keep-alive probe interval, in seconds.
A value of 0 indicates keep-alive is disabled.

Sample:
10
late_binding
boolean
queried
Specifies whether to enable or disable the intelligent selection of a back-end server pool.

Sample:
True
link_qos_to_client
integer
queried
Specifies a Link Quality of Service (QoS) (VLAN priority) number for the client side.
This option specifies the QoS level the system assigns to packets when sending them to clients.

Sample:
7
link_qos_to_server
integer
queried
Specifies a Link QoS (VLAN priority) number for the server side.
This option specifies the QoS level the system assigns to packets when sending them to servers.

Sample:
5
loose_close
boolean
queried
Specifies the system closes a loosely-initiated connection when it receives the first FIN packet from either the client or the server.
loose_init
boolean
queried
Specifies the system initializes a connection when it receives any Transmission Control Protocol (TCP) packet, rather than requiring a SYN packet for connection initiation.

Sample:
True
mss_override
integer
queried
Specifies a maximum segment size (MSS) override for server connections. Note this is also the MSS advertised to a client when a client first connects.
0 (zero), means the option is disabled. Otherwise, the value will be between 256 and 9162.

Sample:
500
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
fastl4
parent
string
queried
Profile from which this profile inherits settings.

Sample:
fastl4
priority_to_client
integer
queried
Specifies the internal packet priority for the client side.
This option specifies the internal packet priority the system assigns to packets when sending them to clients.

Sample:
300
priority_to_server
integer
queried
Specifies the internal packet priority for the server side.
This option specifies the internal packet priority the system assigns to packets when sending them to servers.

Sample:
200
pva_acceleration
string
queried
Specifies the Packet Velocity(r) ASIC acceleration policy.

Sample:
full
pva_dynamic_client_packets
integer
queried
Specifies the number of client packets before dynamic ePVA hardware re-offloading occurs.
Values are between 0 and 10.

Sample:
8
pva_dynamic_server_packets
integer
queried
Specifies the number of server packets before dynamic ePVA hardware re-offloading occurs.
Values are between 0 and 10.

Sample:
5
pva_flow_aging
boolean
queried
Specifies if automatic aging from ePVA flow cache is enabled or not.

Sample:
True
pva_flow_evict
boolean
queried
Specifies if this flow can be evicted upon hash collision with a new flow learn snoop request.
pva_offload_dynamic
boolean
queried
Specifies whether PVA flow dynamic offloading is enabled or not.

Sample:
True
pva_offload_state
string
queried
Specifies at what stage the ePVA performs hardware offload.
When embryonic, applies at TCP CSYN or the first client UDP packet.
When establish, applies TCP 3WAY handshaking or UDP CS round trip are confirmed.

Sample:
embryonic
reassemble_fragments
boolean
queried
Specifies whether to reassemble fragments.

Sample:
True
receive_window
integer
queried
Specifies the window size to use, in bytes.
The maximum is 2^31 for window scale enabling.

Sample:
1000
reset_on_timeout
boolean
queried
Specifies whether you want to reset connections on timeout.

Sample:
True
rtt_from_client
boolean
queried
Enables or disables the TCP timestamp options to measure the round trip time to the client.
rtt_from_server
boolean
queried
Enables or disables the TCP timestamp options to measure the round trip time to the server.

Sample:
True
server_sack
boolean
queried
Specifies whether to support the server sack option in cookie responses by default.
server_timestamp
boolean
queried
Specifies whether to support the server timestamp option in cookie responses by default.

Sample:
True
software_syn_cookie
boolean
queried
Enables or disables software SYN cookie support when PVA10 is not present on the system.
This option is deprecated in version 13.0.0 and is replaced by syn_cookie_enabled.

Sample:
True
strip_sack
boolean
queried
Specifies whether you want to block the TCP SackOK option from passing to the server on an initiating SYN.

Sample:
True
syn_cookie_enabled
boolean
queried
Enables syn-cookies capability on this virtual server.
syn_cookie_mss
integer
queried
Specifies a maximum segment size (MSS) for server connections when SYN Cookie is enabled.

Sample:
2000
syn_cookie_whitelist
boolean
queried
Specifies whether or not to use a SYN Cookie WhiteList when doing software SYN Cookies.
tcp_close_timeout
integer
queried
Specifies a TCP close timeout in seconds.

Sample:
100
tcp_handshake_timeout
integer
queried
Specifies a TCP handshake timeout in seconds.

Sample:
5
tcp_time_wait_timeout
integer
queried
Specifies a TCP time_wait timeout in milliseconds.

Sample:
60
tcp_timestamp_mode
string
queried
Specifies how you want to handle the TCP timestamp.

Sample:
preserve
tcp_window_scale_mode
string
queried
Specifies how you want to handle the TCP window scale.

Sample:
preserve
timeout_recovery
string
queried
Specifies late binding timeout recovery mode. This is the action to take when late binding timeout occurs on a connection.
When disconnect, only the L7 iRule actions are acceptable to pick a server.
When fallback, the normal FastL4 load balancing methods are acceptable to pick a server.

Sample:
fallback
ttl_mode
string
queried
Describes the outgoing TCP packet's IP Header TTL mode.
When proxy, sets the outgoing IP Header TTL value to 255/64 for IPv4/IPv6 respectively.
When preserve, sets the outgoing IP Header TTL value to be same as the incoming IP Header TTL value.
When decrement, sets the outgoing IP Header TTL value to be one less than the incoming TTL value.
When set, sets the outgoing IP Header TTL value to a specific value (as specified by ttl_v4 or ttl_v6.

Sample:
preserve
ttl_v4
integer
queried
Specifies the outgoing packet's IP Header TTL value for IPv4 traffic.
Maximum value is 255.

Sample:
200
ttl_v6
integer
queried
Specify the outgoing packet's IP Header TTL value for IPv6. traffic.
Maximum value is 255.

Sample:
300
gateway_icmp_monitors
complex
When gateway-icmp-monitors is specified in gather_subset.
Gateway ICMP monitor related information.

Sample:
hash/dictionary of values
adaptive
boolean
queried
Whether adaptive response time monitoring is enabled for this monitor.
adaptive_divergence_type
string
queried
Specifies whether the adaptive-divergence-value is relative or absolute.

Sample:
relative
adaptive_divergence_value
integer
queried
Specifies how far from mean latency each monitor probe is allowed to be.

Sample:
25
adaptive_limit
integer
queried
Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value.

Sample:
200
adaptive_sampling_timespan
integer
queried
Specifies the size of the sliding window, in seconds, which records probe history.

Sample:
300
description
string
queried
Description of the resource.

Sample:
My monitor
destination
string
queried
Specifies the IP address and service port of the resource that is the destination of this monitor.

Sample:
*:*
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/gateway_icmp
interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

Sample:
5
manual_resume
boolean
queried
Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
gateway_icmp
parent
string
queried
Profile from which this profile inherits settings.

Sample:
gateway_icmp
time_until_up
integer
queried
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
timeout
integer
queried
Specifies the number of seconds the target has in which to respond to the monitor request.

Sample:
16
transparent
boolean
queried
Specifies whether the monitor operates in transparent mode.
up_interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up.
gtm_pools
complex
When any of gtm-pools or gtm-*-pools is specified in gather_subset.
GTM pool related information.
Every "type" of pool has the exact same list of possible information. Therefore, the list of information here is presented once instead of 6 times.

Sample:
hash/dictionary of values
alternate_mode
string
queried
The load balancing mode the system uses to load balance name resolution requests among the members of the pool.

Sample:
drop-packet
disabled
boolean
queried
Specifies the pool is disabled.
dynamic_ratio
boolean
queried
Specifies whether the dynamic ratio load balancing algorithm is enabled for this pool.

Sample:
True
enabled
boolean
queried
Specifies the pool is enabled.
fallback_mode
string
queried
Specifies the load balancing mode the system uses to load balance name resolution among the pool members if the preferred and alternate modes are unsuccessful in picking a pool.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/pool1
load_balancing_mode
string
queried
Specifies the preferred load balancing mode the system uses to load balance requests across pool members.
manual_resume
boolean
queried
Whether manual resume is enabled for this pool.
max_answers_returned
integer
queried
Maximum number of available virtual servers the system lists in a response.
members
dictionary
queried
Lists of members (and their configurations) in the pool.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
pool1
partition
string
queried
Partition on which the pool exists.
qos_hit_ratio
integer
queried
Weight of the Hit Ratio performance factor for the QoS dynamic load balancing method.
qos_hops
integer
queried
Weight of the Hops performance factor when load balancing mode or fallback mode is QoS.
qos_kilobytes_second
integer
queried
Weight assigned to the Kilobytes per Second performance factor when the load balancing option is QoS.
qos_lcs
integer
queried
Weight assigned to the Link Capacity performance factor when the load balacing option is QoS.
qos_packet_rate
integer
queried
Weight assigned to the Packet Rate performance factor when the load balacing option is QoS.
qos_rtt
integer
queried
Weight assigned to the Round Trip Time performance factor when the load balacing option is QoS.
qos_topology
integer
queried
Weight assigned to the Topology performance factor when the load balacing option is QoS.
qos_vs_capacity
integer
queried
Weight assigned to the Virtual Server performance factor when the load balacing option is QoS.
qos_vs_score
integer
queried
Weight assigned to the Virtual Server Score performance factor when the load balacing option is QoS.
ttl
integer
queried
Number of seconds the IP address, once found, is valid.
verify_member_availability
boolean
queried
Whether or not the system verifies the availability of the members before sending a connection to them.
gtm_servers
complex
When gtm-servers is specified in gather_subset.
GTM server related information.

Sample:
hash/dictionary of values
addresses
dictionary
queried
Specifies the server IP addresses.
datacenter
string
queried
Full name of the datacenter to which this server belongs.
devices
dictionary
queried
Specifies the names of the devices that represent this server.
disabled
boolean
queried
Specifies the server is disabled.
enabled
boolean
queried
Specifies the server is enabled.
expose_route_domains
boolean
queried
Allow the GTM server to auto-discover the LTM virtual servers from all route domains.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/server1
iq_allow_path
boolean
queried
Whether the GTM uses this BIG-IP system to conduct a path probe before delegating traffic to it.
iq_allow_service_check
boolean
queried
Whether the GTM uses this BIG-IP system to conduct a service check probe before delegating traffic to it.
iq_allow_snmp
boolean
queried
Whether the GTM uses this BIG-IP system to conduct an SNMP probe before delegating traffic to it.
limit_cpu_usage
integer
queried
For a server configured as a generic host, specifies the percent of CPU usage, otherwise this has no effect.
limit_cpu_usage_status
boolean
queried
Whether limit_cpu_usage is enabled for this server.
limit_max_bps
integer
queried
Maximum allowable data throughput rate in bits per second for this server.
limit_max_bps_status
boolean
queried
Whether limit_max_bps is enabled for this server.
limit_max_connections
integer
queried
Maximum number of concurrent connections, combined, for this server.
limit_max_connections_status
boolean
success
Whether limit_max_connections is enabled for this server.
limit_max_pps
integer
queried
Maximum allowable data transfer rate for this server, in packets per second.
limit_max_pps_status
boolean
queried
Whether limit_max_pps is enabled for this server.
limit_mem_available
integer
queried
For a server configured as a generic host, specifies the available memory required by the virtual servers on the server.
If available memory falls below this limit, the system marks the server as unavailable.
limit_mem_available_status
boolean
queried
Whether limit_mem_available is enabled for this server.
link_discovery
string
queried
Specifies whether the system auto-discovers the links for this server.
monitor_type
string
queried
Whether one or more monitors need to pass, or all monitors need to pass.

Sample:
and_list
monitors
list / elements=string
queried
Specifies health monitors that the system uses to determine whether this server is available for load balancing.

Sample:
['/Common/https_443', '/Common/icmp']
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
server1
prober_fallback
string
queried
The type of prober to use to monitor this server's resources when the preferred type is not available.
prober_preference
string
queried
Specifies the type of prober to use to monitor this server's resources.
product
string
queried
Specifies the server type.
virtual_server_discovery
string
queried
Whether the system auto-discovers the virtual servers for this server.
virtual_servers
dictionary
queried
Specifies the virtual servers that are resources for this server.
gtm_topology_regions
complex
When gtm-topology-regions is specified in gather_subset
GTM regions related information.

Sample:
hash/dictionary of values
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/region1
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
region1
region_members
complex
success
The list of region members.

Sample:
hash/dictionary of values
continent
string
when configured for the region member.
The name of one of the seven continents in ISO format, along with the Unknown setting.

Sample:
AF
country
string
when configured for the region member.
The country name returned as an ISO country code.
Valid country codes can be found here https://countrycode.org/.

Sample:
US
datacenter
string
when configured for the region member.
The name of a GTM data center already defined in the configuration.

Sample:
/Common/dc1
geo_isp
string
when configured for the region member.
Specifies a geolocation ISP.

Sample:
/Common/FOO_ISP
isp
string
when configured for the region member.
Specifies an Internet service provider.

Sample:
/Common/AOL
negate
boolean
when configured for the region member.
Indicates if the region member is a IS-NOT negative. In a BIG-IP configuration, the region members can be IS or IS-NOT.

Sample:
True
pool
string
when configured for the region member.
The name of a GTM pool already defined in the configuration.

Sample:
/Common/pool1
region
string
when configured for the region member.
The name of region already defined in the configuration.

Sample:
/Common/region1
state
string
when configured for the region member.
The state in a given country.

Sample:
AD/Sant Julia de Loria
subnet
string
when configured for the region member.
An IP address and network mask in the CIDR format.

Sample:
10.10.10.0/24
gtm_wide_ips
complex
When any of gtm-wide-ips or gtm-*-wide-ips is specified in gather_subset.
GTM Wide IP related information.
Every "type" of Wide IP has the exact same list of possible information. Therefore, the list of information here is presented once instead of 6 times.

Sample:
hash/dictionary of values
description
string
queried
Description of the Wide IP.
disabled
boolean
queried
Whether the Wide IP is disabled.
enabled
boolean
queried
Whether the Wide IP is enabled.
failure_rcode
integer
queried
Specifies the DNS RCODE used when failure_rcode_response is yes.
failure_rcode_response
boolean
queried
When yes, specifies the system returns a RCODE response to Wide IP requests after exhausting all load balancing methods.
failure_rcode_ttl
integer
queried
Specifies the negative caching TTL of the SOA for the RCODE response.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/wide1
last_resort_pool
string
queried
Specifies which pool, as listed in Pool List, for the system to use as the last resort pool for the Wide IP.
minimal_response
string
queried
Specifies the system forms the smallest allowable DNS response to a query.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
wide1
persist_cidr_ipv4
integer
queried
Specifies the number of bits the system uses to identify IPv4 addresses when persistence is enabled.
persist_cidr_ipv6
integer
queried
Specifies the number of bits the system uses to identify IPv6 addresses when persistence is enabled.
pool_lb_mode
string
queried
Specifies the load balancing method used to select a pool in this Wide IP.
pools
dictionary
queried
Specifies the pools this Wide IP uses for load balancing.
ttl_persistence
integer
queried
Specifies, in seconds, the length of time for which the persistence entry is valid.
http_monitors
complex
When http-monitors is specified in gather_subset.
HTTP monitor related information.

Sample:
hash/dictionary of values
adaptive
boolean
queried
Whether adaptive response time monitoring is enabled for this monitor.
adaptive_divergence_type
string
queried
Specifies whether the adaptive-divergence-value is relative or absolute.

Sample:
relative
adaptive_divergence_value
integer
queried
Specifies how far from mean latency each monitor probe is allowed to be.

Sample:
25
adaptive_limit
integer
queried
Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value.

Sample:
200
adaptive_sampling_timespan
integer
queried
Specifies the size of the sliding window, in seconds, which records probe history.

Sample:
300
description
string
queried
Description of the resource.

Sample:
My monitor
destination
string
queried
Specifies the IP address and service port of the resource that is the destination of this monitor.

Sample:
*:*
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/http
interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

Sample:
5
ip_dscp
integer
queried
Specifies the differentiated services code point (DSCP).
manual_resume
boolean
queried
Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
http
parent
string
queried
Profile from which this profile inherits settings.

Sample:
http
receive_disable_string
string
queried
Specifies a text string the monitor looks for in the returned resource. If the text string is matched in the returned resource, the corresponding node or pool member is marked session disabled.

Sample:
check disable string
receive_string
string
queried
Specifies the text string the monitor looks for in the returned resource.

Sample:
check string
reverse
boolean
queried
Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful check marks the monitored object down instead of up.
send_string
string
queried
Specifies the text string the monitor sends to the target object.

Sample:
GET /\r\n
time_until_up
integer
queried
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
timeout
integer
queried
Specifies the number of seconds the target has in which to respond to the monitor request.

Sample:
16
transparent
boolean
queried
Specifies whether the monitor operates in transparent mode.
up_interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up.
username
string
queried
Specifies the username, if the monitored target requires authentication.

Sample:
user1
http_profiles
complex
When http-profiles is specified in gather_subset.
HTTP profile related information.

Sample:
hash/dictionary of values
accept_xff
boolean
queried
Enables or disables trusting the client IP address, and statistics from the client IP address, based on the request's X-Forwarded-For (XFF) headers, if they exist.

Sample:
True
allow_truncated_redirects
boolean
queried
Specifies the pass-through behavior when a redirect lacking the trailing carriage-return and line feed pair at the end of the headers is parsed.
When no, the system will silently drop the invalid HTTP.
default_connect_handling
string
queried
Specifies the behavior of the proxy service when handling outbound requests.

Sample:
deny
description
string
queried
Description of the resource.

Sample:
My profile
excess_client_headers
string
queried
Specifies the pass-through behavior when the max_header_count value is exceeded by the client.
When reject, the system rejects the connection.

Sample:
reject
excess_server_headers
string
queried
Specifies the pass-through behavior when max_header_count value is exceeded by the server.
When reject, the system rejects the connection.

Sample:
reject
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/http
hsts_enabled
boolean
queried
When yes, enables the HTTP Strict Transport Security settings.

Sample:
True
hsts_include_subdomains
boolean
queried
When yes, applies the HSTS policy to the HSTS host and its subdomains.

Sample:
True
insert_xforwarded_for
boolean
queried
When yes, specifies the system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling.
known_methods
list / elements=string
queried
Optimizes the behavior of a known HTTP method in the list.
The default methods include the following HTTP/1.1 methods. CONNECT, DELETE, GET, HEAD, LOCK, OPTIONS, POST, PROPFIND, PUT, TRACE, UNLOCK.
If a known method is deleted from the known_methods list, the BIG-IP system applies the unknown_method setting to manage that traffic.

Sample:
['CONNECT', 'DELETE', '...']
lws_max_columns
integer
queried
Specifies the maximum column width for any given line, when inserting an HTTP header in an HTTP request.

Sample:
80
max_header_count
integer
queried
Specifies the maximum number of headers the system supports.

Sample:
64
max_header_size
integer
queried
Specifies the maximum size, in bytes, the system allows for all HTTP request headers combined, including the request line.

Sample:
32768
max_requests
integer
queried
Specifies the number of requests the system accepts on a per-connection basis.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
http
onconnect_transformations
boolean
queried
When yes, specifies the system performs HTTP header transformations for the purpose of keeping connections open.

Sample:
True
oversize_client_headers
string
queried
Specifies the pass-through behavior when the max_header_size value is exceeded by the client.

Sample:
reject
oversize_server_headers
string
queried
Specifies the pass-through behavior when the max_header_size value is exceeded by the server.

Sample:
reject
parent
string
queried
Profile from which this profile inherits settings.

Sample:
http
pipeline_action
string
queried
Enables or disables HTTP/1.1 pipelining.

Sample:
allow
proxy_mode
string
queried
Specifies the proxy mode for this profile. Either reverse, explicit, or transparent.

Sample:
reverse
redirect_rewrite
string
queried
Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses.

Sample:
none
request_chunking
string
queried
Specifies how the system handles HTTP content that is chunked by a client.

Sample:
preserve
response_chunking
string
queried
Specifies how the system handles HTTP content that is chunked by a server.

Sample:
selective
server_agent_name
string
queried
Specifies the string used as the server name in traffic generated by LTM.

Sample:
BigIP
sflow_poll_interval
integer
queried
The maximum interval in seconds between two pollings.
sflow_sampling_rate
integer
queried
Specifies the ratio of packets observed to the samples generated.
unknown_method
string
queried
Specifies the behavior (allow, reject, or pass through) when an unknown HTTP method is parsed.

Sample:
allow
via_request
string
queried
Specifies whether to Remove, Preserve, or Append Via headers included in a client request to an origin web server.

Sample:
preserve
via_response
string
queried
Specifies whether to Remove, Preserve, or Append Via headers included in an origin web server response to a client.

Sample:
preserve
https_monitors
complex
When https-monitors is specified in gather_subset.
HTTPS monitor related information.

Sample:
hash/dictionary of values
adaptive
boolean
queried
Whether adaptive response time monitoring is enabled for this monitor.
adaptive_divergence_type
string
queried
Specifies whether the adaptive-divergence-value is relative or absolute.

Sample:
relative
adaptive_divergence_value
integer
queried
Specifies how far from mean latency each monitor probe is allowed to be.

Sample:
25
adaptive_limit
integer
queried
Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value.

Sample:
200
adaptive_sampling_timespan
integer
queried
Specifies the size of the sliding window, in seconds, which records probe history.

Sample:
300
description
string
queried
Description of the resource.

Sample:
My monitor
destination
string
queried
Specifies the IP address and service port of the resource that is the destination of this monitor.

Sample:
*:*
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/http
interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

Sample:
5
ip_dscp
integer
queried
Specifies the differentiated services code point (DSCP).
manual_resume
boolean
queried
Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
http
parent
string
queried
Profile from which this profile inherits settings.

Sample:
http
receive_disable_string
string
queried
Specifies a text string the monitor looks for in the returned resource. If the text string is matched in the returned resource, the corresponding node or pool member is marked session disabled.

Sample:
check disable string
receive_string
string
queried
Specifies the text string the monitor looks for in the returned resource.

Sample:
check string
reverse
boolean
queried
Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful check marks the monitored object down instead of up.
send_string
string
queried
Specifies the text string the monitor sends to the target object.

Sample:
GET /\r\n
ssl_profile
string
queried
Specifies the SSL profile to use for the HTTPS monitor.

Sample:
/Common/serverssl
time_until_up
integer
queried
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
timeout
integer
queried
Specifies the number of seconds the target has in which to respond to the monitor request.

Sample:
16
transparent
boolean
queried
Specifies whether the monitor operates in transparent mode.
up_interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up.
username
string
queried
Specifies the username, if the monitored target requires authentication.

Sample:
user1
iapp_services
complex
When iapp-services is specified in gather_subset.
iApp v1 service related information.

Sample:
hash/dictionary of values
description
string
queried
Description of the service.

Sample:
My service
device_group
string
queried
The device group the iApp service is part of.

Sample:
/Common/dg1
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/service1
inherited_device_group
boolean
queried
Whether the device group is inherited or not.

Sample:
True
inherited_traffic_group
boolean
queried
Whether the traffic group is inherited or not.

Sample:
True
lists
list / elements=string
queried
List of the lists data used to create the service.

Sample:
[{'name': 'irules__irules'}, {'value': []}, '...']
metadata
list / elements=string
queried
List of the metadata data used to create the service.

Sample:
[{'name': 'var1'}, {'persist': 'true'}, '...']
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
service1
strict_updates
boolean
queried
Whether strict updates are enabled or not.

Sample:
True
tables
list / elements=string
queried
List of the tabular data used to create the service.

Sample:
[{'name': 'basic__snatpool_members'}, '...']
template_modified
boolean
queried
Whether template the service is based on is modified from its default value, or not.

Sample:
True
traffic_group
string
queried
Traffic group the service is a part of.

Sample:
/Common/tg
variables
list / elements=string
queried
List of the variable data used to create the service.

Sample:
[{'name': 'afm__policy'}, {'encrypted': 'no'}, {'value': '/#no_not_use#'}, '...']
icmp_monitors
complex
When icmp-monitors is specified in gather_subset.
ICMP monitor related information.

Sample:
hash/dictionary of values
adaptive
boolean
queried
Whether adaptive response time monitoring is enabled for this monitor.
adaptive_divergence_type
string
queried
Specifies whether the adaptive-divergence-value is relative or absolute.

Sample:
relative
adaptive_divergence_value
integer
queried
Specifies how far from mean latency each monitor probe is allowed to be.

Sample:
25
adaptive_limit
integer
queried
Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value.

Sample:
200
adaptive_sampling_timespan
integer
queried
Specifies the size of the sliding window, in seconds, which records probe history.

Sample:
300
description
string
queried
Description of the resource.

Sample:
My monitor
destination
string
queried
Specifies the IP address and service port of the resource that is the destination of this monitor.

Sample:
*:*
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/icmp
interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

Sample:
5
manual_resume
boolean
success
Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
icmp
parent
string
queried
Profile from which this profile inherits settings.

Sample:
icmp
time_until_up
integer
queried
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
timeout
integer
queried
Specifies the number of seconds the target has in which to respond to the monitor request.

Sample:
16
transparent
boolean
queried
Specifies whether the monitor operates in transparent mode.
up_interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up.
interfaces
complex
When interfaces is specified in gather_subset.
Interface related information.

Sample:
hash/dictionary of values
active_media_type
string
queried
Displays the current media setting for the interface.

Sample:
100TX-FD
bundle
string
queried
The bundle capability on the port.

Sample:
not-supported
bundle_speed
string
queried
The bundle-speed on the port when bundle capability is enabled.

Sample:
100G
description
string
queried
Description of the interface.

Sample:
My interface
enabled
boolean
queried
Whether the interface is enabled or not.

Sample:
True
flow_control
string
queried
Specifies how the system controls the sending of PAUSE frames for flow control.

Sample:
tx-rx
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/interface1
if_index
integer
queried
The index assigned to this interface.

Sample:
32
lldp_admin
string
queried
Sets the sending or receiving of LLDP packets on that interface. Should be one of disable, txonly, rxonly or txrx.

Sample:
txonly
mac_address
string
queried
Displays the 6-byte ethernet address in non-case-sensitive hexadecimal colon notation.

Sample:
00:0b:09:88:00:9a
media_sfp
string
queried
The settings for an SFP (pluggable) interface.

Sample:
auto
mtu
integer
queried
Displays the Maximum Transmission Unit (MTU) of the interface, which is the maximum number of bytes in a frame without IP fragmentation.

Sample:
1500
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
interface1
prefer_port
string
queried
Indicates which side of a combo port the interface uses, if both sides of the port have the potential for external links.

Sample:
sfp
sflow_poll_interval
integer
queried
Specifies the maximum interval in seconds between two pollings.
sflow_poll_interval_global
boolean
queried
Specifies whether the global interface poll-interval setting overrides the object-level poll-interval setting.

Sample:
True
stp_auto_edge_port
boolean
queried
STP edge port detection.

Sample:
True
stp_enabled
boolean
queried
Whether STP is enabled or not.
stp_link_type
string
queried
Specifies the STP link type for the interface.

Sample:
auto
irules
complex
When irules is specified in gather_subset.
iRule related information.

Sample:
hash/dictionary of values
checksum
string
queried
Checksum of the iRule as calculated by BIG-IP.

Sample:
d41d8cd98f00b204e9800998ecf8427e
definition
string
queried
The actual definition of the iRule.

Sample:
when HTTP_REQUEST ...
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/irule1
ignore_verification
boolean
queried
Whether the verification of the iRule should be ignored or not.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
irule1
signature
string
queried
The calculated signature of the iRule.

Sample:
WsYy2M6xMqvosIKIEH/FSsvhtWMe6xKOA6i7f...
ltm_policies
complex
When ltm-policies is specified in gather_subset.
List of LTM (Local Traffic Manager) policies.

Sample:
hash/dictionary of values
controls
list / elements=string
queried
Aspects of the system controlled by this policy.

Sample:
['forwarding']
description
string
queried
Description of the policy.

Sample:
My policy
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/policy1
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
policy1
requires
list / elements=string
queried
Aspects of the system required by this policy.

Sample:
['http']
rules
complex
when rules are defined in the policy.
List of LTM (Local Traffic Manager) policy rules.

Sample:
hash/dictionary of values
actions
complex
when actions are defined in the rule.
The actions the policy will take when a match is encountered.

Sample:
hash/dictionary of values
http_reply
boolean
when defined in the action.
Indicates if the action affects a reply to a given HTTP request.

Sample:
True
location
string
when defined in the action.
This action will come from the given location.

Sample:
tcl:https://[getfield [HTTP::host] \":\" 1][HTTP::uri]
redirect
boolean
when defined in the action.
This action will redirect a request.
request
boolean
when defined in the action.
This policy action is performed on connection requests.
conditions
complex
when conditions are defined in the rule.
The conditions a policy will match on.

Sample:
hash/dictionary of values
address
boolean
when defined in the condition.
This condition matches on a TCP address.
all
boolean
when defined in the condition.
Matches all.

Sample:
True
case_insensitive
boolean
when defined in the condition.
Specifies the value matched on is case insensitive.
case_sensitive
boolean
when defined in the condition.
Specifies the value matched on is case sensitive.

Sample:
True
contains_string
boolean
when defined in the condition.
Specifies the value matches if it contains a certain string.

Sample:
True
datagroup
string
when defined in the condition.
This condition matches on an HTTP URI.

Sample:
/Common/policy_using_datagroup
external
boolean
when defined in the condition.
Specifies the value matched on is from the external side of a connection.

Sample:
True
http_basic_auth
boolean
when defined in the condition.
This condition matches on basic HTTP authorization.
http_host
boolean
when defined in the condition.
This condition matches on an HTTP host.

Sample:
True
http_uri
boolean
when defined in the condition.
This condition matches on an HTTP URI.
matches
boolean
when defined in the condition.
This condition matches on an address.
proxy_connect
boolean
when defined in the condition.
Specifies the value matched on is proxyConnect.
proxy_request
boolean
when defined in the condition.
Specifies the value matched on is proxyRequest.
remote
boolean
when defined in the condition.
Specifies the value matched on is remote.
request
boolean
when defined in the condition.
This policy matches on a request.

Sample:
True
tcp
boolean
when defined in the condition.
This condition matches on TCP parameters.
username
boolean
when defined in the condition.
Matches on a username.

Sample:
True
values
list / elements=string
when defined in the condition.
The specified values will be matched on.

Sample:
['foo.bar.com', 'baz.cool.com']
status
string
queried
Indicates published or draft policy status.

Sample:
draft
strategy
string
queried
The match strategy for the policy.

Sample:
/Common/first-match
ltm_pools
complex
When ltm-pools is specified in gather_subset.
List of LTM (Local Traffic Manager) pools.

Sample:
hash/dictionary of values
active_member_count
integer
queried
The number of active pool members in the pool.

Sample:
3
all_avg_queue_entry_age
integer
queried
Average queue entry age, for both the pool and its members.

Sample:
5
all_max_queue_entry_age_ever
integer
queried
Maximum queue entry age ever, for both the pool and its members.

Sample:
2
all_max_queue_entry_age_recently
integer
queried
Maximum queue entry age recently, for both the pool and its members.

Sample:
5
all_num_connections_queued_now
integer
queried
Number of connections queued now, for both the pool and its members.

Sample:
20
all_num_connections_serviced
integer
queried
Number of connections serviced, for both the pool and its members.

Sample:
15
all_queue_head_entry_age
integer
queried
Queue head entry age, for both the pool and its members.

Sample:
4
allow_nat
boolean
queried
Whether NATs are automatically enabled or disabled for any connections using this pool.

Sample:
True
allow_snat
boolean
queried
Whether SNATs are automatically enabled or disabled for any connections using this pool.

Sample:
True
availability_status
string
queried
The availability of the pool.

Sample:
offline
available_member_count
integer
queried
The number of available pool members in the pool.

Sample:
4
client_ip_tos
string
queried
Whether the system sets a Type of Service (ToS) level within a packet sent to the client, based on the targeted pool.
Values can range from 0 to 255, or be set to pass-through or mimic.

Sample:
pass-through
client_link_qos
string
queried
Whether the system sets a Quality of Service (QoS) level within a packet sent to the client, based on the targeted pool.
Values can range from 0 to 7, or be set to pass-through.

Sample:
pass-through
current_sessions
integer
queried
Current sessions.

Sample:
2
description
string
queried
Description of the pool.

Sample:
my pool
enabled_status
string
queried
The enabled status of the pool.

Sample:
enabled
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/pool1
ignore_persisted_weight
boolean
queried
Specifies not to count the weight of persisted connections on pool members when making load balancing decisions.
lb_method
string
queried
Load balancing method used by the pool.

Sample:
round-robin
member_count
integer
queried
Total number of members in the pool.

Sample:
50
members
complex
when members exist in the pool.
List of LTM (Local Traffic Manager) pools.
address
string
queried
IP address of the pool member.

Sample:
1.1.1.1
connection_limit
integer
queried
The maximum number of concurrent connections allowed for a pool member.
description
string
queried
The description of the pool member.

Sample:
pool member 1
dynamic_ratio
integer
queried
A range of numbers you want the system to use in conjunction with the ratio load balancing method.

Sample:
1
encapsulation_profile
string
queried
The encapsulation profile to use for the pool member.

Sample:
ip4ip4
ephemeral
boolean
queried
Whether the node backing the pool member is ephemeral or not.

Sample:
True
fqdn_autopopulate
boolean
queried
Whether the node should scale to the IP address set returned by DNS.

Sample:
True
full_path
string
queried
Full name of the resource as known to the BIG-IP.
Includes the port in the name.

Sample:
/Common/member:80
inherit_profile
boolean
queried
Whether the pool member inherits the encapsulation profile from the parent pool.
logging
boolean
queried
Whether the monitor applied should log its actions.
monitors
list / elements=string
queried
The Monitors active on the pool member. Monitor names are in their "full_path" form.

Sample:
['/Common/http']
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
member:80
partition
string
queried
Partition the member exists on.

Sample:
Common
priority_group
integer
queried
The priority group within the pool for this pool member.
rate_limit
boolean
queried
The maximum number of connections per second allowed for a pool member.
ratio
integer
queried
The weight of the pool for load balancing purposes.

Sample:
1
session
string
queried
Enables or disables the pool member for new sessions.

Sample:
monitor-enabled
state
string
queried
Controls the state of the pool member, overriding any monitors.

Sample:
down
metadata
dictionary
queried
Dictionary of arbitrary key/value pairs set on the pool.

Sample:
hash/dictionary of values
minimum_active_members
integer
queried
Whether the system load balances traffic according to the priority number assigned to the pool member.
This parameter is identical to priority_group_activation and is just an alias for it.

Sample:
2
minimum_up_members
integer
queried
The minimum number of pool members that must be up.

Sample:
1
minimum_up_members_action
string
queried
The action to take if the minimum_up_members_checking is enabled and the number of active pool members falls below the number specified in minimum_up_members.

Sample:
failover
minimum_up_members_checking
boolean
queried
Enables or disables the minimum_up_members feature.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
pool1
pool_avg_queue_entry_age
integer
queried
Average queue entry age, for the pool only.

Sample:
5
pool_max_queue_entry_age_ever
integer
queried
Maximum queue entry age ever, for the pool only.

Sample:
2
pool_max_queue_entry_age_recently
integer
queried
Maximum queue entry age recently, for the pool only.

Sample:
5
pool_num_connections_queued_now
integer
queried
Number of connections queued now, for the pool only.

Sample:
20
pool_num_connections_serviced
integer
queried
Number of connections serviced, for the pool only.

Sample:
15
pool_queue_head_entry_age
integer
queried
Queue head entry age, for the pool only.

Sample:
4
priority_group_activation
integer
queried
Whether the system load balances traffic according to the priority number assigned to the pool member.
This parameter is identical to minimum_active_members and is just an alias for it.

Sample:
2
queue_depth_limit
integer
queried
The maximum number of connections that may simultaneously be queued to go to any member of this pool.

Sample:
3
queue_on_connection_limit
boolean
queried
Enable or disable queuing connections when pool member or node connection limits are reached.

Sample:
True
queue_time_limit
integer
queried
Specifies the maximum time, in milliseconds, a connection will remain queued.
real_session
string
queried
The actual REST API value for the session attribute.
This is different from the state return value, as the return value can be considered a generalization of all available sessions, instead of the specific value of the session.

Sample:
monitor-enabled
real_state
string
queried
The actual REST API value for the state attribute.
This is different from the state return value, as the return value can be considered a generalization of all available states, instead of the specific value of the state.

Sample:
up
reselect_tries
integer
queried
The number of times the system tries to contact a pool member after a passive failure.
server_ip_tos
string
queried
The Type of Service (ToS) level to use when sending packets to a server.

Sample:
pass-through
server_link_qos
string
queried
The Quality of Service (QoS) level to use when sending packets to a server.

Sample:
pass-through
server_side_bits_in
integer
queried
Number of server-side ingress bits.

Sample:
1000
server_side_bits_out
integer
queried
Number of server-side egress bits.

Sample:
200
server_side_current_connections
integer
queried
Number of current connections server-side.

Sample:
300
server_side_max_connections
integer
queried
Maximum number of connections server-side.

Sample:
40
server_side_pkts_in
integer
queried
Number of server-side ingress packets.

Sample:
1098384
server_side_pkts_out
integer
queried
Number of server-side egress packets.

Sample:
3484734
server_side_total_connections
integer
queried
Total number of server-side connections.

Sample:
24
service_down_action
string
queried
The action to take if the service specified in the pool is marked down.

Sample:
none
slow_ramp_time
integer
queried
The ramp time for the pool.
This provides the ability for a pool member that is newly enabled or marked up to receive proportionally less traffic than other members in the pool.

Sample:
10
status_reason
string
queried
If there is a problem with the status of the pool, it is reported here.

Sample:
The children pool member(s) are down.
total_requests
integer
queried
Total requests.

Sample:
8
management_routes
complex
When management-routes is specified in gather_subset.
Management route related information.

Sample:
hash/dictionary of values
description
string
queried
User defined description of the route.

Sample:
route-1-external
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/default
gateway
string
queried
The gateway IP address through which the system forwards packets to the destination.

Sample:
192.168.0.1
mtu
string
queried
The maximum transmission unit for the management interface.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
default
network
string
queried
The destination subnet and netmask, also specified as default or default-inet6.

Sample:
default
nodes
complex
When nodes is specified in gather_subset.
Node related information.

Sample:
hash/dictionary of values
address
string
queried
IP address of the node.

Sample:
2.3.4.5
availability_status
string
queried
The availability of the node.

Sample:
offline
connection_limit
integer
queried
Maximum number of connections the node can handle.

Sample:
100
description
string
queried
Description of the node.

Sample:
My node
dynamic_ratio
integer
queried
Dynamic ratio number for the node used when doing Dynamic Ratio load balancing.

Sample:
200
enabled_status
string
queried
The enabled status of the node.

Sample:
enabled
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/5.6.7.8
monitor_rule
string
queried
A string representation of the full monitor rule.

Sample:
/Common/https_443 and /Common/icmp
monitor_status
string
queried
Status of the node as reported by the monitor(s) associated with it.
This value is also used in determining node state.

Sample:
down
monitor_type
string
queried
The monitor_type field related to the bigip_node module, for this nodes monitors.

Sample:
and_list
monitors
list / elements=string
queried
A list of the monitors identified in the monitor_rule.

Sample:
['/Common/https_443', '/Common/icmp']
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
5.6.7.8
rate_limit
integer
queried
Maximum number of connections per second allowed for the node.

Sample:
1000
ratio
integer
queried
Fixed size ratio used for node during Ratio load balancing.

Sample:
10
session_status
string
queried
This value is also used in determining node state.

Sample:
enabled
status_reason
string
queried
If there is a problem with the status of the node, it is reported here.

Sample:
/Common/https_443 No successful responses received...
oneconnect_profiles
complex
When oneconnect-profiles is specified in gather_subset.
OneConnect profile related information.

Sample:
hash/dictionary of values
description
string
queried
Description of the resource.

Sample:
My profile
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/oneconnect
idle_timeout_override
integer
queried
Specifies the number of seconds that a connection is idle before the connection flow is eligible for deletion.

Sample:
1000
limit_type
string
queried
When none, simultaneous in-flight requests and responses over TCP connections to a pool member are counted toward the limit.
When idle, idle connections will be dropped as the TCP connection limit is reached.
When strict, the TCP connection limit is honored with no exceptions. This means idle connections will prevent new TCP connections from being made until they expire, even if they could otherwise be reused.

Sample:
idle
max_age
integer
queried
Specifies the maximum age, in seconds, of a connection in the connection reuse pool.

Sample:
100
max_reuse
integer
queried
Specifies the maximum number of times a server connection can be reused.

Sample:
1000
max_size
integer
queried
Specifies the maximum number of connections the system holds in the connection reuse pool.
If the pool is already full, then the server connection closes after the response is completed.

Sample:
1000
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
oneconnect
parent
string
queried
Profile from which this profile inherits settings.

Sample:
oneconnect
share_pools
boolean
queried
Indicates connections may be shared not only within a virtual server, but also among similar virtual servers.

Sample:
True
source_mask
string
queried
Specifies a source IP mask.
If no mask is provided, the value any6 is used.

Sample:
255.255.255.0
partitions
complex
When partitions is specified in gather_subset.
Partition related information.

Sample:
hash/dictionary of values
default_route_domain
integer
queried
ID of the route domain that is associated with the IP addresses that reside in the partition.
description
string
queried
Description of the partition.

Sample:
Tenant 1
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
Common
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
Common
provision_info
complex
When provision-info is specified in gather_subset.
Module provisioning related information.

Sample:
hash/dictionary of values
cpu_ratio
integer
queried
Ratio of CPU allocated to this module.
Only relevant if level was specified as custom. Otherwise, this value will be reported as 0.
disk_ratio
integer
queried
Ratio of disk allocated to this module.
Only relevant if level was specified as custom. Otherwise, this value will be reported as 0.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
asm
level
integer
queried
Provisioned level of the module on BIG-IP.
Valid return values can include none, minimum, nominal, dedicated and custom.
memory_ratio
integer
queried
Ratio of memory allocated to this module.
Only relevant if level was specified as custom. Otherwise, this value will be reported as 0.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
asm
remote_syslog
complex
When remote-syslog is specified in gather_subset.
Remote Syslog related information.

Sample:
hash/dictionary of values
servers
complex
queried
Configured remote syslog servers.

Sample:
hash/dictionary of values
local_ip
string
queried
The local IP address of the remote syslog server.

Sample:
10.10.10.10
name
string
queried
Name of remote syslog server as configured on the system.

Sample:
/Common/foobar1
remote_host
string
queried
The IP address or hostname of the remote syslog server.

Sample:
192.168.1.1
remote_port
integer
queried
Remote port of the remote syslog server.

Sample:
514
route_domains
complex
When self-ips is specified in gather_subset.
Route domain related information.

Sample:
hash/dictionary of values
bwc_policy
string
queried
The bandwidth controller for the route domain.

Sample:
/Common/foo
connection_limit
integer
queried
The new connection limit for the route domain.

Sample:
100
description
string
queried
Description of the Route Domain.

Sample:
My route domain
flow_eviction_policy
string
queried
The new eviction policy to use with this route domain.

Sample:
/Common/default-eviction-policy
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/rd1
id
integer
queried
The unique identifying integer representing the route domain.

Sample:
10
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
rd1
parent
string
queried
The route domain the system searches when it cannot find a route in the configured domain.
routing_protocol
list / elements=string
queried
List of routing protocols applied to the route domain.

Sample:
['bfd', 'bgp']
service_policy
string
queried
The new service policy to use with this route domain.

Sample:
/Common-my-service-policy
strict
string
queried
The new strict isolation setting.

Sample:
enabled
vlans
list / elements=string
queried
List of new VLANs the route domain is applied to.

Sample:
['/Common/http-tunnel', '/Common/socks-tunnel']
self_ips
complex
When self-ips is specified in gather_subset.
Self IP related information.

Sample:
hash/dictionary of values
allow_access_list
list / elements=string
queried
List of protocols, and optionally their ports, that are allowed to access the Self IP. Also known as port-lockdown in the web interface.
Items in the list are in the format of "protocol:port". Some items may not have a port associated with them and in those cases the port is 0.

Sample:
['tcp:80', 'egp:0']
description
string
queried
Description of the Self IP.

Sample:
My self-ip
floating
boolean
queried
Whether the Self IP is a floating address or not.

Sample:
True
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/self1
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
self1
netmask
string
queried
Netmask portion of the IP address, in dotted notation.

Sample:
255.255.255.0
netmask_cidr
integer
queried
Netmask portion of the IP address, in CIDR notation.

Sample:
24
service_policy
string
queried
Service policy assigned to the Self IP.

Sample:
/Common/service1
traffic_group
string
queried
Traffic group the Self IP is associated with.

Sample:
/Common/traffic-group-local-only
traffic_group_inherited
boolean
queried
Whether or not the traffic group is inherited.
vlan
string
queried
VLAN associated with the Self IP.

Sample:
/Common/vlan1
server_ssl_profiles
complex
When server-ssl-profiles is specified in gather_subset.
Server SSL related information.

Sample:
hash/dictionary of values
alert_timeout
string
queried
Maximum time period in seconds to keep the SSL session active after an alert message is sent, or indefinite.

Sample:
100
allow_expired_crl
boolean
queried
Use the specified CRL file, even if it has expired.

Sample:
True
authenticate_depth
integer
queried
The client certificate chain maximum traversal depth

Sample:
9
authenticate_name
string
queried
Common Name (CN) embedded in a server certificate.
The system authenticates a server based on the specified CN.

Sample:
foo
authentication_frequency
string
queried
Specifies the frequency of authentication.

Sample:
once
bypass_on_client_cert_fail
boolean
queried
Enables or disables SSL forward proxy bypass on failing to get client certificate that the server asks for.

Sample:
True
bypass_on_handshake_alert
boolean
queried
Enables or disables SSL forward proxy bypass on receiving handshake_failure, protocol_version or unsupported_extension alert message during the serverside SSL handshake.
c3d_ca_cert
string
queried
Name of the certificate file used as the certification authority certificate when SSL client certificate constrained delegation is enabled.

Sample:
/Common/cacert.crt
c3d_ca_key
string
queried
Name of the key file used as the certification authority key when SSL client certificate constrained delegation is enabled.

Sample:
/Common/default.key
c3d_cert_extension_includes
list / elements=string
queried
Extensions of the client certificates to be included in the generated certificates using SSL client certificate constrained delegation.

Sample:
['basic-constraints', 'extended-key-usage', '...']
c3d_cert_lifespan
integer
queried
Lifespan of the certificate generated using the SSL client certificate constrained delegation.

Sample:
24
ca_file
string
queried
Certificate authority file name.

Sample:
default.crt
cache_size
integer
queried
The SSL session cache size.

Sample:
262144
cache_timeout
integer
queried
The SSL session cache timeout value, which is the usable lifetime seconds of negotiated SSL session IDs.

Sample:
86400
cert
string
queried
The name of the certificate installed on the traffic management system for the purpose of terminating or initiating an SSL connection.

Sample:
/Common/default.crt
chain
string
queried
Specifies or builds a certificate chain file that a client can use to authenticate the profile.

Sample:
/Common/default.crt
cipher_group
string
queried
Specifies a cipher group.
ciphers
string
queried
Specifies a cipher name.

Sample:
DEFAULT
crl_file
string
queried
Specifies the certificate revocation list file name.
description
string
queried
Description of the resource.

Sample:
My profile
expire_cert_response_control
string
queried
Specifies the BIGIP action when the server certificate has expired.

Sample:
drop
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
serverssl
generic_alert
boolean
queried
Enables or disables generic-alert.

Sample:
True
handshake_timeout
string
queried
Specifies the handshake timeout in seconds.

Sample:
10
key
string
queried
Specifies the name of the key installed on the traffic management system for the purpose of terminating or initiating an SSL connection.

Sample:
/Common/default.key
max_active_handshakes
string
queried
Specifies the maximum number of allowed active SSL handshakes.

Sample:
100
mod_ssl_methods
boolean
queried
Enables or disables ModSSL methods.

Sample:
True
mode
boolean
queried
Enables or disables SSL processing.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
serverssl
ocsp
string
queried
Specifies the name of the OCSP profile for validating the status of the server certificate.
options
list / elements=string
queried
Enables options, including some industry-related workarounds.

Sample:
['netscape-reuse-cipher-change-bug', 'dont-insert-empty-fragments']
parent
string
queried
Profile from which this profile inherits settings.

Sample:
serverssl
peer_cert_mode
string
queried
Specifies the peer certificate mode.

Sample:
ignore
proxy_ssl
boolean
queried
Allows further modification of application traffic within an SSL tunnel while still allowing the server to perform necessary authorization, authentication, auditing steps.

Sample:
True
proxy_ssl_passthrough
boolean
queried
Allows Proxy SSL to passthrough the traffic when ciphersuite negotiated between the client and server is not supported.

Sample:
True
renegotiate_period
string
queried
Number of seconds from the initial connect time after which the system renegotiates an SSL session.

Sample:
indefinite
renegotiate_size
string
queried
Specifies a throughput size of SSL renegotiation, in megabytes.

Sample:
indefinite
renegotiation
boolean
queried
Whether renegotiations are enabled.

Sample:
True
retain_certificate
boolean
queried
APM module requires storing certificates in the SSL session. When no, a certificate will not be stored in the SSL session.
secure_renegotiation
string
queried
Specifies the secure renegotiation mode.

Sample:
require
server_name
string
queried
Server name to be included in the SNI (server name indication) extension during SSL handshake in ClientHello.
session_mirroring
boolean
queried
Enables or disables the mirroring of sessions to the high availability peer.

Sample:
True
session_ticket
boolean
queried
Enables or disables session-ticket.
sni_default
boolean
queried
When yes, this profile is the default SSL profile when the server name in a client connection does not match any configured server names, or a client connection does not specify any server name at all.

Sample:
True
sni_require
boolean
queried
When yes, connections to a server that do not support SNI extension will be rejected.
ssl_c3d
boolean
queried
Enables or disables SSL Client certificate constrained delegation.

Sample:
True
ssl_forward_proxy_bypass
boolean
queried
Enables or disables the ssl-forward-proxy-bypass feature.

Sample:
True
ssl_forward_proxy_enabled
boolean
queried
Enables or disables the ssl-forward-proxy feature.
ssl_sign_hash
string
queried
Specifies the SSL sign hash algorithm which is used to sign and verify SSL Server Key Exchange and Certificate Verify messages for the specified SSL profiles.

Sample:
sha1
strict_resume
boolean
queried
Enables or disables the resumption of SSL sessions after an unclean shutdown.
unclean_shutdown
boolean
queried
Specifies, when yes, that the SSL profile performs unclean shutdowns of all SSL connections. This means underlying TCP connections are closed without exchanging the required SSL shutdown alerts.

Sample:
True
untrusted_cert_response_control
string
queried
Specifies the BIG-IP action when the server certificate has an untrusted CA.

Sample:
drop
software_hotfixes
complex
When software-hotfixes is specified in gather_subset.
List of software hotfixes.

Sample:
hash/dictionary of values
build
string
queried
Build number of the image.
This is usually a sub-string of the name.

Sample:
3.0.1679
checksum
string
queried
MD5 checksum of the image.
Note that this is the checksum stored inside the ISO. It is not the actual checksum of the ISO.

Sample:
df1ec715d2089d0fa54c0c4284656a98
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso
id
string
queried
ID component of the image.
This is usually a sub-string of the name.

Sample:
HF3
name
string
queried
Name of the image.

Sample:
Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso
product
string
queried
Product contained in the ISO.

Sample:
BIG-IP
title
string
queried
Human friendly name of the image.

Sample:
Hotfix Version 3.0.1679
verified
boolean
queried
Specifies whether the system has verified this image.

Sample:
True
version
string
queried
Version of software contained in the image.
This is a sub-string of the name.

Sample:
13.0.0
software_images
complex
When software-images is specified in gather_subset.
List of software images.

Sample:
hash/dictionary of values
build
string
queried
Build number of the image.
This is usually a sub-string of the name.

Sample:
0.0.1
build_date
string
queried
Date of the build.

Sample:
2018-05-05T15:26:30
checksum
string
queried
MD5 checksum of the image.
Note that this is the checksum stored inside the ISO. It is not the actual checksum of the ISO.

Sample:
df1ec715d2089d0fa54c0c4284656a98
file_size
integer
queried
Size of the image, in megabytes.

Sample:
1938
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
BIGIP-13.1.0.7-0.0.1.iso
last_modified
string
queried
Last modified date of the ISO.

Sample:
2018-05-05T15:26:30
name
string
queried
Name of the image.

Sample:
BIGIP-13.1.0.7-0.0.1.iso
product
string
queried
Product contained in the ISO.

Sample:
BIG-IP
verified
boolean
queried
Whether or not the system has verified this image.

Sample:
True
version
string
queried
Version of software contained in the image.
This is a sub-string of the name.

Sample:
13.1.0.7
software_volumes
complex
When software-volumes is specified in gather_subset.
List of software volumes.

Sample:
hash/dictionary of values
active
boolean
queried
Whether the volume is currently active or not.
An active volume contains the currently running version of software.

Sample:
True
base_build
string
queried
Base build version of the software installed in the volume.
When a hotfix is installed, this refers to the base version of software that the hotfix requires.

Sample:
0.0.6
build
string
queried
Build version of the software installed in the volume.

Sample:
0.0.6
default_boot_location
boolean
queried
Whether this volume is the default boot location or not.

Sample:
True
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
HD1.1
name
string
queried
Relative name of the resource in the BIG-IP.
This usually matches the full_name.

Sample:
HD1.1
product
string
queried
The F5 product installed in this slot.
This should always be BIG-IP.

Sample:
BIG-IP
status
string
queried
Status of the software installed, or being installed, in the volume.
When complete, indicates the software has completed installing.

Sample:
complete
version
string
queried
Version of software installed in the volume, excluding the build number.

Sample:
13.1.0.4
ssl_certs
complex
When ssl-certs is specified in gather_subset.
SSL certificate related information.

Sample:
hash/dictionary of values
create_time
string
queried
Specifies the time the file-object was created.

Sample:
2018-05-15T21:11:15Z
expiration_date
string
queried
Specifies a string representation of the expiration date of the certificate.

Sample:
Aug 13 21:21:29 2031 GMT
expiration_timestamp
integer
queried
Specifies the date this certificate expires. Stored as a POSIX time.

Sample:
1944422489
fingerprint
string
queried
Displays the SHA-256 fingerprint of the certificate.

Sample:
SHA256/88:A3:05:...:59:01:EA:5D:B0
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/cert1
is_bundle
boolean
queried
Specifies whether the certificate file is a bundle (that is, whether it contains more than one certificate).
issuer
string
queried
Specifies X509 information of the certificate's issuer.

Sample:
[email protected],...CN=support.f5.com,
key_size
integer
queried
Specifies the size (in bytes) of the file associated with this file object.

Sample:
2048
key_type
string
queried
Specifies the type of cryptographic key associated with this certificate.

Sample:
rsa-private
last_update_time
string
queried
Specifies the last time the file-object was updated/modified.

Sample:
2018-05-15T21:11:15Z
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
cert1
serial_no
string
queried
Specifies certificate's serial number

Sample:
1234567890
sha1_checksum
string
queried
SHA1 checksum of the certificate.

Sample:
1306e84e1e6a2da53816cefe1f684b80d6be1e3e
subject
string
queried
Specifies X509 information of the certificate's subject.

Sample:
subject_alternative_name
string
queried
Displays the Subject Alternative Name for the certificate.
The X509v3 Subject Alternative Name is embedded in the certificate for X509 extension purposes.

Sample:
DNS:www.example.com, DNS:www.example.internal.net
system_path
string
queried
Path on the BIG-IP where the cert can be found.

Sample:
/config/ssl/ssl.crt/f5-irule.crt
ssl_keys
complex
When ssl-keys is specified in gather_subset.
SSL certificate related information.

Sample:
hash/dictionary of values
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/key1
key_size
integer
queried
Specifies the size of the cryptographic key associated with this file object, in bits.

Sample:
2048
key_type
string
queried
Specifies the cryptographic type of the key. That is, which algorithm this key is compatible with.

Sample:
rsa-private
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
key1
security_type
string
queried
Specifies the type of security used to handle or store the key.

Sample:
normal
sha1_checksum
string
queried
The SHA1 checksum of the key.

Sample:
1fcf7de3dd8e834d613099d8e10b2060cd9ecc9f
system_path
string
queried
The path on the filesystem where the key is stored.

Sample:
/config/ssl/ssl.key/default.key
sync_status
complex
When sync-status is specified in gather_subset.
Configuration Synchronization Status across all Device Groups.
Note that the sync-status works across all device groups - a specific device group cannot be queried for its sync-status.
In general the device-group with the 'worst' sync-status will be shown.

Sample:
hash/dictionary of values
color
string
queried
Sync status color.
Eg. red, blue, green, yellow

Sample:
red
details
list / elements=string
queried
A list of all details provided for the current sync-status of the device

Sample:
[{'Optional action': 'Add a device to the trust domain'}]
mode
string
queried
Device operation mode (high-availability, standalone)

Sample:
['high-availability', 'standalone']
recommended_action
string
queried
The next recommended action to take on the current sync-status.
This field might be empty.

Sample:
Synchronize bigip-a.example.com to group some-device-group
status
string
queried
Synchronization Status

Sample:
['Changes Pending', 'In Sync', 'Standalone', 'Disconnected']
summary
string
queried
The configuration synchronization status summary

Sample:
['The device group is awaiting the initial config sync', 'There is a possible change conflict between ...']
system_db
complex
When system-db is specified in gather_subset.
System DB related information.

Sample:
hash/dictionary of values
default
string
queried
Default value of the key.

Sample:
www.f5.com
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
vendor.wwwurl
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
vendor.wwwurl
scf_config
string
queried
Whether the database key would be found in an SCF config or not.
value
string
queried
The value of the key.

Sample:
www.f5.com
value_range
string
queried
The accepted range of values for the key.

Sample:
string
system_info
complex
When traffic-groups is specified in gather_subset.
Traffic group related information.

Sample:
hash/dictionary of values
base_mac_address
string
queried
Media Access Control address (MAC address) of the device.

Sample:
fa:16:3e:c3:42:6f
chassis_serial
string
queried
Serial of the chassis.

Sample:
11111111-2222-3333-444444444444
hardware_information
complex
queried
Information related to the hardware (drives and CPUs) of the system.
model
string
queried
The model of the hardware.

Sample:
Virtual Disk
name
string
queried
The name of the hardware.

Sample:
HD1
type
string
queried
The type of hardware.

Sample:
physical-disk
versions
complex
queried
Hardware specific properties.
name
string
queried
Name of the property.

Sample:
Size
version
string
queried
Value of the property.

Sample:
154.00G
host_board_part_revision
string
queried
Revision of the host board.
host_board_serial
string
queried
Serial of the host board.
marketing_name
string
queried
Marketing name of the device platform.

Sample:
BIG-IP Virtual Edition
package_edition
string
queried
Displays the software edition.

Sample:
Point Release 7
package_version
string
queried
A string combining the product_build and product_build_date.

Sample:
Build 0.0.1 - Tue May 15 15:26:30 PDT 2018
platform
string
queried
Platform identifier.

Sample:
Z100
product_build
string
queried
Build version of the release version.

Sample:
0.0.1
product_build_date
string
queried
Human readable build date.

Sample:
Tue May 15 15:26:30 PDT 2018
product_built
integer
queried
UNIX timestamp of when the product was built.

Sample:
180515152630
product_changelist
integer
queried
Changelist the product branches from.

Sample:
2557198
product_code
string
queried
Code identifying the product.

Sample:
BIG-IP
product_jobid
integer
queried
ID of the job that built the product version.

Sample:
1012030
product_version
string
queried
Major product version of the running software.

Sample:
13.1.0.7
switch_board_part_revision
string
queried
Switch board revision.
switch_board_serial
string
queried
Serial of the switch board.
time
complex
queried
Mapping of the current time information to specific time-named keys.
day
integer
queried
The current day of the month, in numeric form.

Sample:
7
hour
integer
queried
The current hour of the day in 24-hour format.

Sample:
18
minute
integer
queried
The current minute of the hour.

Sample:
16
month
integer
queried
The current month, in numeric form.

Sample:
6
second
integer
queried
The current second of the minute.

Sample:
51
year
integer
queried
The current year in 4-digit format.

Sample:
2018
uptime
integer
queried
Time since the system booted, in seconds.

Sample:
603202
tcp_half_open_monitors
complex
When tcp-half-open-monitors is specified in gather_subset.
TCP Half-open monitor related information.

Sample:
hash/dictionary of values
description
string
queried
Description of the resource.

Sample:
My monitor
destination
string
queried
Specifies the IP address and service port of the resource that is the destination of this monitor.

Sample:
*:*
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/tcp
interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

Sample:
5
manual_resume
boolean
queried
Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
tcp
parent
string
queried
Profile from which this profile inherits settings.

Sample:
tcp
time_until_up
integer
queried
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
timeout
integer
queried
Specifies the number of seconds the target has in which to respond to the monitor request.

Sample:
16
transparent
boolean
queried
Specifies whether the monitor operates in transparent mode.
up_interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up.
tcp_monitors
complex
When tcp-monitors is specified in gather_subset.
TCP monitor related information.

Sample:
hash/dictionary of values
adaptive
boolean
queried
Whether adaptive response time monitoring is enabled for this monitor.
adaptive_divergence_type
string
queried
Specifies whether the adaptive-divergence-value is relative or absolute.

Sample:
relative
adaptive_divergence_value
integer
queried
Specifies how far from mean latency each monitor probe is allowed to be.

Sample:
25
adaptive_limit
integer
queried
Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value.

Sample:
200
adaptive_sampling_timespan
integer
queried
Specifies the size of the sliding window, in seconds, which records probe history.

Sample:
300
description
string
queried
Description of the resource.

Sample:
My monitor
destination
string
queried
Specifies the IP address and service port of the resource that is the destination of this monitor.

Sample:
*:*
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/tcp
interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

Sample:
5
ip_dscp
integer
queried
Specifies the differentiated services code point (DSCP).
manual_resume
boolean
queried
Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
tcp
parent
string
queried
Profile from which this profile inherits settings.

Sample:
tcp
reverse
boolean
queried
Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful check marks the monitored object down instead of up.
time_until_up
integer
queried
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
timeout
integer
queried
Specifies the number of seconds the target has in which to respond to the monitor request.

Sample:
16
transparent
boolean
queried
Specifies whether the monitor operates in transparent mode.
up_interval
integer
queried
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up.
tcp_profiles
complex
When tcp-profiles is specified in gather_subset.
TCP profile related information.

Sample:
hash/dictionary of values
abc
boolean
queried
Appropriate Byte Counting (RFC 3465)
When yes, increases the congestion window by basing the amount to increase on the number of previously unacknowledged bytes that each ACK covers.

Sample:
True
ack_on_push
boolean
queried
When yes, specifies significantly improved performance to Microsoft Windows and MacOS peers who are writing out on a very small send buffer.
auto_proxy_buffer
boolean
queried
When yes, specifies the system uses the network measurements to set the optimal proxy buffer size.

Sample:
True
auto_receive_window
boolean
queried
When yes, specifies the system uses the network measurements to set the optimal receive window size.
auto_send_buffer
boolean
queried
When yes, specifies the system uses the network measurements to set the optimal send buffer size.

Sample:
True
close_wait
string
queried
Specifies the length of time a TCP connection remains in the LAST-ACK state before quitting.
In addition to a numeric value, the value of this fact may also be one of immediate or indefinite.
When immediate, specifies the TCP connection closes immediately after entering the LAST-ACK state.
When indefinite, specifies that TCP connections in the LAST-ACK state do not close until they meet the maximum retransmissions timeout.

Sample:
indefinite
congestion_control
string
queried
Specifies the algorithm to use to share network resources among competing users to reduce congestion.
Return values may include, high-speed, cdg, chd, none, cubic, illinois, new-reno, reno, scalable, vegas, westwood, and woodside.

Sample:
high-speed
congestion_metrics_cache
boolean
queried
When yes, specifies the system uses a cache for storing congestion metrics.
Subsequently, because these metrics are already known and cached, the initial slow-start ramp for previously-encountered peers improves.

Sample:
True
congestion_metrics_cache_timeout
integer
queried
Specifies the number of seconds for which entries in the congestion metrics cache are valid.
deferred_accept
boolean
queried
When yes, specifies the system defers allocation of the connection chain context until the system has received the payload from the client.
Enabling this setting is useful in dealing with 3-way handshake denial-of-service attacks.

Sample:
True
delay_window_control
boolean
queried
Specifies the system uses an estimate of queuing delay as a measure of congestion to control, in addition to the normal loss-based control, the amount of data sent.

Sample:
True
delayed_acks
boolean
queried
When checked (enabled), specifies the system can send fewer than one ACK (acknowledgment) segment per data segment received.

Sample:
True
description
string
queried
Description of the resource.

Sample:
My profile
dont_fragment_flag
string
queried
Specifies the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet.

Sample:
pmtu
dsack
boolean
queried
D-SACK (RFC 2883)
When yes, specifies the use of the selective ACK (SACK) option to acknowledge duplicate segments.

Sample:
True
early_retransmit
boolean
queried
When yes, specifies the system uses early retransmit (as specified in RFC 5827) to reduce the recovery time for connections that are receive- buffer or user-data limited.

Sample:
True
enhanced_loss_recovery
boolean
queried
Specifies whether the system uses enhanced loss recovery to recover from random packet losses more effectively.

Sample:
True
explicit_congestion_notification
boolean
queried
When yes, specifies the system uses the TCP flags CWR (congestion window reduction) and ECE (ECN-Echo) to notify its peer of congestion and congestion counter-measures.

Sample:
True
fast_open
boolean
queried
When yes, specifies, the system supports TCP Fast Open, which reduces latency by allowing a client to include the first packet of data with the SYN

Sample:
True
fast_open_cookie_expiration
integer
queried
Specifies the number of seconds that a Fast Open Cookie delivered to a client is valid for SYN packets from that client.

Sample:
1000
fin_wait_1
string
queried
Specifies the length of time that a TCP connection is in the FIN-WAIT-1 or CLOSING state before quitting.

Sample:
indefinite
fin_wait_2
string
queried
Specifies the length of time a TCP connection is in the FIN-WAIT-2 state before quitting.

Sample:
100
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
tcp
idle_timeout
string
queried
Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion.

Sample:
300
initial_congestion_window_size
integer
queried
Specifies the initial congestion window size for connections to this destination.

Sample:
3
initial_receive_window_size
integer
queried
Specifies the initial receive window size for connections to this destination.

Sample:
5
ip_tos
string
queried
Specifies the L3 Type of Service (ToS) level the system inserts in TCP packets destined for clients.

Sample:
mimic
keep_alive_interval
string
queried
Specifies how frequently the system sends data over an idle TCP connection, to determine whether the connection is still valid.

Sample:
50
limited_transmit_recovery
boolean
queried
When yes, specifies the system uses limited transmit recovery revisions for fast retransmits (as specified in RFC 3042) to reduce the recovery time for connections on a lossy network.

Sample:
True
link_qos
string
queried
Specifies the L2 Quality of Service (QoS) level the system inserts in TCP packets destined for clients.

Sample:
200
max_segment_retrans
integer
queried
Specifies the maximum number of times that the system resends data segments.

Sample:
8
max_segment_size
integer
queried
Specifies the largest amount of data the system can receive in a single TCP segment, not including the TCP and IP headers.

Sample:
1460
max_syn_retrans
integer
queried
Specifies the maximum number of times the system resends a SYN packet when it does not receive a corresponding SYN-ACK.

Sample:
3
md5_signature
boolean
queried
When yes, specifies to use RFC2385 TCP-MD5 signatures to protect TCP traffic against intermediate tampering.

Sample:
True
minimum_rto
integer
queried
Specifies the minimum length of time the system waits for acknowledgements of data sent before resending the data.

Sample:
1000
mptcp_checksum
boolean
queried
When yes, specifies the system calculates the checksum for MPTCP connections.
mptcp_checksum_verify
boolean
queried
When yes, specifies the system verifies the checksum for MPTCP connections.
mptcp_fallback
string
queried
Specifies an action on fallback, that is, when MPTCP transitions to regular TCP, because something prevents MPTCP from working correctly.

Sample:
reset
mptcp_fast_join
boolean
queried
When yes, specifies a FAST join, allowing data to be sent on the MP_JOIN_SYN, which can allow a server response to occur in parallel with the JOIN.
mptcp_idle_timeout
integer
queried
Specifies the number of seconds that an MPTCP connection is idle before the connection is eligible for deletion.

Sample:
300
mptcp_join_max
integer
queried
Specifies the highest number of MPTCP connections that can join to a given connection.

Sample:
5
mptcp_make_after_break
boolean
queried
Specifies make-after-break functionality is supported, allowing for long-lived MPTCP sessions.
mptcp_no_join_dss_ack
boolean
queried
When checked (enabled), specifies no DSS option is sent on the JOIN ACK.
mptcp_retransmit_min
integer
queried
Specifies the minimum value (in msec) of the retransmission timer for these MPTCP flows.

Sample:
1000
mptcp_rto_max
integer
queried
Specifies the number of RTOs (retransmission timeouts) before declaring the subflow dead.

Sample:
5
mptcp_subflow_max
integer
queried
Specifies the maximum number of MPTCP subflows for a single flow.

Sample:
6
mptcp_timeout
integer
queried
Specifies, in seconds, the timeout value to discard long-lived sessions that do not have an active flow.

Sample:
3600
multipath_tcp
boolean
queried
When yes, specifies the system accepts Multipath TCP (MPTCP) connections, which allow multiple client-side flows to connect to a single server-side flow.

Sample:
True
nagle_algorithm
boolean
queried
Specifies whether the system applies Nagle's algorithm to reduce the number of short segments on the network.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
/Common/tcp
parent
string
queried
Profile from which this profile inherits settings.

Sample:
tcp
pkt_loss_ignore_burst
integer
queried
Specifies the probability of performing congestion control when multiple packets are lost, even if the Packet Loss Ignore Rate was not exceeded.
pkt_loss_ignore_rate
integer
queried
Specifies the threshold of packets lost per million at which the system performs congestion control.
proxy_buffer_high
integer
queried
Specifies the proxy buffer level, in bytes, at which the receive window is closed.

Sample:
49152
proxy_buffer_low
integer
queried
Specifies the proxy buffer level, in bytes, at which the receive window is opened.

Sample:
32768
proxy_max_segment
boolean
queried
When yes, specifies the system attempts to advertise the same maximum segment size (MSS) to the server-side connection as that of the client-side connection.

Sample:
True
proxy_options
boolean
queried
When yes, specifies the system advertises an option (such as time stamps) to the server only when the option is negotiated with the client.
push_flag
string
queried
Specifies how the BIG-IP system receives ACKs.

Sample:
default
rate_pace
boolean
queried
When yes, specifies the system paces the egress packets to avoid dropping packets, allowing for optimum goodput.

Sample:
True
rate_pace_max_rate
integer
queried
Specifies the maximum rate in bytes per second to which the system paces TCP data transmission.
receive_window
integer
queried
Specifies the maximum advertised RECEIVE window size.

Sample:
65535
reset_on_timeout
boolean
queried
When yes, specifies the system sends a reset packet (RST) in addition to deleting the connection, when a connection exceeds the idle timeout value.

Sample:
True
retransmit_threshold
integer
queried
Specifies the number of duplicate ACKs (retransmit threshold) to start fast recovery.

Sample:
3
selective_acks
boolean
queried
When yes, specifies the system processes data using selective ACKs (SACKs) whenever possible, to improve system performance.

Sample:
True
selective_nack
boolean
queried
When yes, specifies the system processes data using a selective negative acknowledgment (SNACK) whenever possible, to improve system performance.

Sample:
True
send_buffer
integer
queried
Specifies the SEND window size.

Sample:
65535
slow_start
boolean
queried
When yes, specifies the system uses Slow-Start Congestion Avoidance as described in RFC3390 in order to ramp up traffic without causing excessive congestion on the link.

Sample:
True
syn_cookie_enable
boolean
queried
Specifies the default (if no DoS profile is associated) number of embryonic connections that are allowed on any virtual server, before SYN Cookie challenges are enabled for that virtual server.

Sample:
True
syn_cookie_white_list
boolean
queried
Specifies whether or not to use a SYN Cookie WhiteList when doing software SYN Cookies.
syn_retrans_to_base
integer
queried
Specifies the initial RTO (Retransmission TimeOut) base multiplier for SYN retransmissions.

Sample:
3000
tail_loss_probe
boolean
queried
When yes, specifies the system uses Tail Loss Probe to reduce the number of retransmission timeouts.

Sample:
True
time_to_live
string
queried
Specifies the outgoing TCP packet's IP Header TTL mode.

Sample:
proxy
time_to_live_v4
integer
queried
Specifies the outgoing packet's IP Header TTL value for IPv4 traffic.

Sample:
255
time_to_live_v6
integer
queried
Specifies the outgoing packet's IP Header TTL value for IPv6 traffic.

Sample:
64
time_wait
string
queried
Specifies the length of time that a TCP connection remains in the TIME-WAIT state before entering the CLOSED state.

Sample:
2000
time_wait_recycle
boolean
queried
When yes, specifies that connections in a TIME-WAIT state are reused when the system receives a SYN packet, indicating a request for a new connection.

Sample:
True
timestamps
boolean
queried
When yes, specifies the system uses the timestamps extension for TCP (as specified in RFC 1323) to enhance high-speed network performance.

Sample:
True
verified_accept
boolean
queried
When yes, specifies the system can actually communicate with the server before establishing a client connection.

Sample:
True
zero_window_timeout
string
queried
Specifies the timeout in milliseconds for terminating a connection with an effective zero length TCP transmit window.

Sample:
2000
traffic_groups
complex
When traffic-groups is specified in gather_subset.
Traffic group related information.

Sample:
hash/dictionary of values
auto_failback_enabled
boolean
queried
Specifies whether the traffic group fails back to the default device.

Sample:
True
auto_failback_time
integer
queried
Specifies the time required to fail back.

Sample:
60
description
string
queried
Description of the traffic group.

Sample:
My traffic group
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/tg1
ha_load_factor
integer
queried
Specifies a number for this traffic group that represents the load this traffic group presents to the system relative to other traffic groups.

Sample:
1
ha_order
list / elements=string
queried
This list of devices specifies the order in which the devices will become active for the traffic group when a failure occurs.

Sample:
['/Common/device1', '/Common/device2']
is_floating
boolean
queried
Indicates whether the traffic group can fail over to other devices in the device group.
mac_masquerade_address
string
queried
Specifies a MAC address for the traffic group.

Sample:
00:98:76:54:32:10
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
tg1
trunks
complex
When trunks is specified in gather_subset.
Trunk related information.

Sample:
hash/dictionary of values
configured_member_count
integer
queried
The number of configured members that are associated with the trunk.

Sample:
1
description
string
queried
Description of the Trunk.

Sample:
My trunk
distribution_hash
string
queried
The basis for the hash that the system uses as the frame distribution algorithm.
The system uses this hash to determine which interface to use for forwarding traffic.

Sample:
src-dst-ipport
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/trunk1
interfaces
list / elements=string
queried
The list of interfaces that are part of the trunk.

Sample:
['1.2', '1.3']
lacp_enabled
boolean
queried
Whether LACP is enabled or not.

Sample:
True
lacp_mode
string
queried
The operation mode for LACP.

Sample:
passive
lacp_timeout
integer
queried
The rate at which the system sends the LACP control packets.

Sample:
10
link_selection_policy
string
queried
The LACP policy the trunk uses to determine which member link can handle new traffic.

Sample:
maximum-bandwidth
media_speed
integer
queried
Speed of the media attached to the trunk.

Sample:
10000
media_status
boolean
queried
Whether the media that is part of the trunk is up or not.

Sample:
True
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
trunk1
operational_member_count
integer
queried
Number of working members associated with the trunk.

Sample:
1
stp_enabled
boolean
queried
Whether Spanning Tree Protocol (STP) is enabled or not.

Sample:
True
udp_profiles
complex
When udp-profiles is specified in gather_subset.
UDP profile related information.

Sample:
hash/dictionary of values
allow_no_payload
boolean
queried
Allow the passage of datagrams that contain header information, but no essential data.

Sample:
True
buffer_max_bytes
integer
queried
Ingress buffer byte limit. Maximum allowed value is 16777215.

Sample:
655350
buffer_max_packets
integer
queried
Ingress buffer packet limit. Maximum allowed value is 255.
datagram_load_balancing
boolean
queried
Load balance UDP datagram by datagram

Sample:
True
description
string
queried
Description of the resource.

Sample:
My profile
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
udp
idle_timeout
boolean
queried
Number of seconds that a connection is idle before the connection is eligible for deletion.
In addition to a number, may be one of the values indefinite or immediate.

Sample:
200
ip_df_mode
string
queried
Describes the Don't Fragment (DF) bit setting in the outgoing UDP packet.
May be one of pmtu, preserve, set, or clear.
When pmtu, sets the outgoing UDP packet DF big based on the ip pmtu setting.
When preserve, preserves the incoming UDP packet Don't Fragment bit.
When set, sets the outgoing UDP packet DF bit.
When clear, clears the outgoing UDP packet DF bit.

Sample:
pmtu
ip_tos_to_client
string
queried
The Type of Service level the traffic management system assigns to UDP packets when sending them to clients.
May be numeric, or the values pass-through or mimic.

Sample:
mimic
ip_ttl_mode
string
queried
The outgoing UDP packet's TTL mode.
Valid modes are proxy, preserve, decrement, and set.
When proxy, sets the IP TTL of IPv4 to the default value of 255 and IPv6 to the default value of 64.
When preserve, sets the IP TTL to the original packet TTL value.
When decrement, sets the IP TTL to the original packet TTL value minus 1.
When set, sets the IP TTL with the specified values in ip_ttl_v4 and ip_ttl_v6 values in the same profile.

Sample:
proxy
ip_ttl_v4
integer
queried
IPv4 TTL.

Sample:
10
ip_ttl_v6
integer
queried
IPv6 TTL.

Sample:
100
link_qos_to_client
string
queried
The Quality of Service level the system assigns to UDP packets when sending them to clients.
May be either numberic or the value pass-through.

Sample:
pass-through
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
/Common/udp
no_checksum
boolean
queried
Whether checksum processing is enabled or disabled.
Note that if the datagram is IPv6, the system always performs checksum processing.

Sample:
True
parent
string
queried
Profile from which this profile inherits settings.

Sample:
udp
proxy_mss
boolean
queried
When yes, specifies the system advertises the same mss to the server as was negotiated with the client.

Sample:
True
users
complex
When users is specified in gather_subset.
Details of the users on the system.
description
string
queried
Description of the resource.

Sample:
Admin user
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
admin
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
admin
partition_access
complex
queried
Partition that user has access to, including user role.
name
string
queried
Name of partition.

Sample:
all-partitions
role
string
queried
Role allowed to user on partition.

Sample:
auditor
shell
string
queried
The shell assigned to the user account.

Sample:
tmsh
vcmp_guests
complex
When vcmp-guests is specified in gather_subset.
vCMP related information.

Sample:
hash/dictionary of values
allowed_slots
list / elements=string
queried
List of slots the guest is allowed to be assigned to.

Sample:
[0, 1, 3]
assigned_slots
list / elements=string
queried
Slots the guest is assigned to.

Sample:
[0]
boot_priority
integer
queried
Specifies the boot priority of the guest. A lower number means earlier to boot.

Sample:
65535
cores_per_slot
integer
queried
Number of cores the system allocates to the guest.

Sample:
2
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
guest1
hostname
string
queried
FQDN assigned to the guest.

Sample:
guest1.localdomain
hotfix_image
string
queried
Hotfix image to install onto any of this guest's newly created virtual disks.

Sample:
Hotfix-BIGIP-12.1.3.4-0.0.2-hf1.iso
initial_image
string
queried
Software image to install onto any of this guest's newly created virtual disks.

Sample:
BIGIP-12.1.3.4-0.0.2.iso
mgmt_address
string
queried
Management IP address configuration for the guest.

Sample:
2.3.2.3
mgmt_network
string
queried
Accessibility of this vCMP guest's management network.

Sample:
bridged
mgmt_route
string
queried
Management gateway IP address for the guest.

Sample:
2.2.2.1
min_number_of_slots
integer
queried
Specifies the minimum number of slots the guest must be assigned to.

Sample:
2
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
guest1
number_of_slots
integer
queried
Specifies the number of slots the guest should be assigned to.
This number is always greater than, or equal to, min_number_of_slots.

Sample:
2
ssl_mode
string
queried
The SSL hardware allocation mode for the guest.

Sample:
shared
state
string
queried
Specifies the state of the guest.
May be one of configured, provisioned, or deployed.
Each state implies the actions of all states before it.

Sample:
provisioned
virtual_disk
string
queried
The filename of the virtual disk to use for this guest.

Sample:
guest1.img
vlans
list / elements=string
queried
List of VLANs on which the guest is either enabled or disabled.

Sample:
['/Common/vlan1', '/Common/vlan2']
virtual_addresses
complex
When virtual-addresses is specified in gather_subset.
Virtual address related information.

Sample:
hash/dictionary of values
address
string
queried
The virtual IP address.

Sample:
2.3.4.5
arp_enabled
boolean
queried
Whether or not ARP is enabled for the specified virtual address.

Sample:
True
auto_delete_enabled
boolean
queried
Indicates if the virtual address will be deleted automatically on deletion of the last associated virtual server or not.
connection_limit
integer
queried
Concurrent connection limit for one or more virtual servers.
description
string
queried
The description of the virtual address.

Sample:
My virtual address
enabled
boolean
queried
Whether the virtual address is enabled or not.

Sample:
True
floating
boolean
queried
Property derived from the traffic group. A floating virtual address is a virtual address for a VLAN that serves as a shared address by all devices of a BIG-IP traffic-group.

Sample:
True
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/2.3.4.5
icmp_echo
boolean
queried
Whether the virtual address should reply to ICMP echo requests.

Sample:
True
inherited_traffic_group
boolean
queried
Indicates if the traffic group is inherited from the parent folder.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
2.3.4.5
netmask
string
queried
Netmask of the virtual address.

Sample:
255.255.255.255
route_advertisement
boolean
queried
Specifies the route advertisement setting for the virtual address.
spanning
boolean
queried
Whether or not spanning is enabled for the specified virtual address.
traffic_group
string
queried
Traffic group on which the virtual address is active.

Sample:
/Common/traffic-group-1
virtual_servers
complex
When virtual-addresses is specified in gather_subset.
Virtual address related information.

Sample:
hash/dictionary of values
authentication_profile
list / elements=string
queried
Specifies a list of authentication profile names, separated by spaces, that the virtual server uses to manage authentication.

Sample:
['/Common/ssl_drldp']
auto_lasthop
string
queried
When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface.

Sample:
default
availability_status
string
queried
The availability of the virtual server.

Sample:
offline
bw_controller_policy
string
queried
The bandwidth controller for the system to use to enforce a throughput policy for incoming network traffic.

Sample:
/Common/bw1
client_side_bits_in
integer
queried
Number of client-side ingress bits.

Sample:
1000
client_side_bits_out
integer
queried
Number of client-side egress bits.

Sample:
200
client_side_current_connections
integer
queried
Number of current connections client-side.

Sample:
300
client_side_evicted_connections
integer
queried
Number of evicted connections client-side.

Sample:
100
client_side_max_connections
integer
queried
Maximum number of connections client-side.

Sample:
40
client_side_pkts_in
integer
queried
Number of client-side ingress packets.

Sample:
1098384
client_side_pkts_out
integer
queried
Number of client-side egress packets.

Sample:
3484734
client_side_slow_killed
integer
queried
Number of slow connections killed, client-side.

Sample:
234
client_side_total_connections
integer
queried
Total number of connections.

Sample:
24
cmp_enabled
boolean
queried
Whether or not clustered multi-processor (CMP) acceleration is enabled.

Sample:
True
cmp_mode
string
queried
The clustered-multiprocessing mode.

Sample:
all-cpus
connection_limit
integer
queried
Maximum number of concurrent connections you want to allow for the virtual server.

Sample:
100
connection_mirror_enabled
boolean
queried
Whether or not connection mirroring is enabled.

Sample:
True
cpu_usage_ratio_last_1_min
integer
queried
CPU Usage Ratio (%) Last 1 Minute.
cpu_usage_ratio_last_5_min
integer
queried
CPU Usage Ratio (%) Last 5 Minutes.
cpu_usage_ratio_last_5_sec
integer
queried
CPU Usage Ratio (%) Last 5 Seconds.
current_syn_cache
integer
queried
Current SYN Cache.
default_pool
string
queried
Pool name you want the virtual server to use as the default pool.

Sample:
/Common/pool1
description
string
queried
The description of the virtual server.

Sample:
My virtual
destination
string
queried
Name of the virtual address and service on which the virtual server listens for connections.

Sample:
/Common/2.2.3.3%1:76
destination_address
string
queried
Address portion of the destination.

Sample:
2.3.3.2
destination_port
integer
queried
Port potion of the destination.

Sample:
80
enabled
boolean
queried
Whether or not the virtual is enabled.

Sample:
True
ephemeral_bits_in
integer
queried
Number of ephemeral ingress bits.

Sample:
1000
ephemeral_bits_out
integer
queried
Number of ephemeral egress bits.

Sample:
200
ephemeral_current_connections
integer
queried
Number of ephemeral current connections.

Sample:
300
ephemeral_evicted_connections
integer
queried
Number of ephemeral evicted connections.

Sample:
100
ephemeral_max_connections
integer
queried
Maximum number of ephemeral connections.

Sample:
40
ephemeral_pkts_in
integer
queried
Number of ephemeral ingress packets.

Sample:
1098384
ephemeral_pkts_out
integer
queried
Number of ephemeral egress packets.

Sample:
3484734
ephemeral_slow_killed
integer
queried
Number of ephemeral slow connections killed.

Sample:
234
ephemeral_total_connections
integer
queried
Total number of ephemeral connections.

Sample:
24
fallback_persistence_profile
string
queried
Fallback persistence profile for the virtual server to use when the default persistence profile is not available.

Sample:
/Common/fallback1
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/2.3.4.5
gtm_score
integer
queried
Specifies a score that is associated with the virtual server.
hardware_syn_cookie_instances
integer
queried
Hardware SYN Cookie Instances.
ip_intelligence_policy
string
queried
IP Intelligence policy assigned to the virtual.

Sample:
/Common/ip1
irules
list / elements=string
queried
List of iRules that customize the virtual server to direct and manage traffic.

Sample:
['/Common/rule1', "/Common/rule2'"]
last_hop_pool
string
queried
Name of the last hop pool you want the virtual server to use to direct reply traffic to the last hop router.

Sample:
/Common/pool1
max_conn_duration
integer
queried
Max Conn Duration/msec.
mean_conn_duration
integer
queried
Mean Conn Duration/msec.
min_conn_duration
integer
queried
Min Conn Duration/msec.
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
2.3.4.5
nat64_enabled
boolean
queried
Whether or not NAT64 is enabled.

Sample:
True
persistence_profile
string
queried
The persistence profile you want the system to use as the default for this virtual server.

Sample:
/Common/persist1
policies
list / elements=string
queried
List of LTM policies attached to the virtual server.

Sample:
['/Common/policy1', "/Common/policy2'"]
profiles
complex
success
List of the profiles attached to the virtual.
context
string
queried
Which side of the connection the profile affects; either all, client-side or server-side.

Sample:
client-side
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
/Common/tcp
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
tcp
protocol
string
queried
IP protocol for which you want the virtual server to direct traffic.

Sample:
tcp
rate_class
string
queried
Name of an existing rate class you want the virtual server to use to enforce a throughput policy for incoming network traffic.
rate_limit
integer
queried
Maximum number of connections per second allowed for a virtual server.

Sample:
34
rate_limit_destination_mask
integer
queried
Specifies a mask, in bits, to be applied to the destination address as part of the rate limiting.

Sample:
32
rate_limit_mode
string
queried
Indicates whether the rate limit is applied per virtual object, per source address, per destination address, or some combination thereof.

Sample:
object
rate_limit_source_mask
integer
queried
Specifies a mask, in bits, to be applied to the source address as part of the rate limiting.
security_log_profiles
list / elements=string
queried
Specifies the log profile applied to the virtual server.

Sample:
['/Common/global-network', '/Common/local-dos']
snat_pool
string
queried
Specifies the name of a LSN or SNAT pool used by the specified virtual server.

Sample:
/Common/pool1
snat_type
string
queried
Specifies the type of source address translation associated with the specified virtual server.

Sample:
none
software_syn_cookie_instances
integer
queried
Software SYN Cookie Instances.
source_address
string
queried
Specifies an IP address or network from which the virtual server will accept traffic.

Sample:
0.0.0./0
source_port_behavior
string
queried
Specifies whether the system preserves the source port of the connection.

Sample:
preserve
status_reason
string
queried
If there is a problem with the status of the virtual, it is reported here.

Sample:
The children pool member(s) either don't have service checking...
syn_cache_overflow
integer
queried
SYN Cache Overflow.
syn_cookies_status
string
queried
SYN Cookies Status.

Sample:
not-activated
total_hardware_accepted_syn_cookies
integer
queried
SYN Cookies Total Hardware Accepted.
total_hardware_syn_cookies
integer
queried
SYN Cookies Total Hardware.
total_requests
integer
queried
Total requests.

Sample:
8
total_software_accepted_syn_cookies
integer
queried
SYN Cookies Total Software Accepted.
total_software_rejected_syn_cookies
integer
queried
Total Software Rejected.
total_software_syn_cookies
integer
queried
Total Software SYN Cookies
translate_address
boolean
queried
Enables or disables address translation for the virtual server.

Sample:
True
translate_port
boolean
queried
Enables or disables port translation.

Sample:
True
type
string
queried
Virtual server type.

Sample:
standard
vlans
list / elements=string
queried
List of VLANs on which the virtual server is either enabled or disabled.

Sample:
['/Common/vlan1', '/Common/vlan2']
vlans
complex
When vlans is specified in gather_subset.
List of VLAN information.

Sample:
hash/dictionary of values
auto_lasthop
string
queried
Allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface.

Sample:
enabled
cmp_hash_algorithm
string
queried
Specifies how the traffic on the VLAN will be disaggregated.

Sample:
default
description
string
queried
Description of the VLAN.

Sample:
My vlan
failsafe_action
string
queried
Action for the system to take when the fail-safe mechanism is triggered.

Sample:
reboot
failsafe_enabled
boolean
queried
Whether failsafe is enabled or not.

Sample:
True
failsafe_timeout
integer
queried
Number of seconds that an active unit can run without detecting network traffic on this VLAN before it starts a failover.

Sample:
90
if_index
integer
queried
Index assigned to this VLAN. It is a unique identifier assigned for all objects displayed in the SNMP IF-MIB.

Sample:
176
interfaces
complex
queried
List of tagged or untagged interfaces and trunks that you want to configure for the VLAN.
full_path
string
queried
Full name of the resource as known to the BIG-IP.

Sample:
1.3
name
string
queried
Relative name of the resource in the BIG-IP.

Sample:
1.3
tagged
boolean
queried
Whether the interface is tagged or not.
learning_mode
string
queried
Whether switch ports placed in the VLAN are configured for switch learning, forwarding only, or dropped.

Sample:
enable-forward
mtu
integer
queried
Specific maximum transition unit (MTU) for the VLAN.

Sample:
1500
sflow_poll_interval
integer
queried
Maximum interval in seconds between two pollings.
sflow_poll_interval_global
boolean
queried
Whether the global VLAN poll-interval setting overrides the object-level poll-interval setting.
sflow_sampling_rate
integer
queried
Ratio of packets observed to the samples generated.
sflow_sampling_rate_global
boolean
queried
Whether the global VLAN sampling-rate setting overrides the object-level sampling-rate setting.

Sample:
True
source_check_enabled
boolean
queried
Specifies that only connections that have a return route in the routing table are accepted.

Sample:
True
tag
integer
queried
Tag number for the VLAN.

Sample:
30
true_mac_address
string
queried
Media access control (MAC) address for the lowest-numbered interface assigned to this VLAN.

Sample:
fa:16:3e:10:da:ff


Authors

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_device_info_module.html