f5networks / f5networks.f5_modules / 1.28.0 / module / bigip_device_info Collect information from F5 BIG-IP devices | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)f5networks.f5_modules.bigip_device_info (1.28.0) — module
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections: - name: f5networks.f5_modules version: 1.28.0
Collect information from F5 BIG-IP devices.
This module was called C(bigip_device_facts) before Ansible 2.9. The usage did not change.
- 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
- name: Collect BIG-IP information with custom data_increment and specific partition bigip_device_info: data_increment: 50 partition: Foo gather_subset: - gtm-a-wide-ips provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost
provider: description: - A dict object containing connection details. suboptions: auth_provider: description: - Configures the auth provider for to obtain authentication tokens from the remote device. - This option is really used when working with BIG-IQ devices. type: str no_f5_teem: default: false description: - If C(yes), TEEM telemetry data is not sent to F5. - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF). - Previously used variable C(F5_TEEM) is deprecated as its name was confusing. type: bool password: aliases: - pass - pwd description: - The password for the user account used to connect to the BIG-IP or the BIG-IQ. - You may omit this option by setting the environment variable C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host or the BIG-IQ host. - You may omit this option by setting the environment variable C(F5_SERVER). required: true type: str server_port: default: 443 description: - The BIG-IP server port. - You may omit this option by setting the environment variable C(F5_SERVER_PORT). type: int timeout: description: - 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. type: int transport: choices: - rest default: rest description: - Configures the transport connection to use when connecting to the remote device. type: str user: description: - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. - You may omit this option by setting the environment variable C(F5_USER). required: true type: str validate_certs: default: true description: - If C(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 C(F5_VALIDATE_CERTS). type: bool type: dict version_added: 1.0.0 version_added_collection: f5networks.f5_modules partition: default: Common description: - Specifies the partition to gather the resource information from. - The default value for the partition is taken as Common. type: str version_added: 1.14.0 version_added_collection: f5networks.f5_modules gather_subset: aliases: - include 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 - license - ltm-pools - ltm-policies - management-routes - nodes - oneconnect-profiles - packages - 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 - ucs - 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' - '!license' - '!ltm-pools' - '!ltm-policies' - '!management-routes' - '!nodes' - '!oneconnect-profiles' - '!packages' - '!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' - '!ucs' - '!vcmp-guests' - '!virtual-addresses' - '!virtual-servers' - '!vlans' description: - 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 C(!) to specify that a specific subset should not be collected. elements: str required: true type: list data_increment: default: 10 description: - Specifies the paging increment at which device data is gathered from the API. - Allows for greater control of the pace at which data is queried from the device. - This setting is useful for setups with large configurations which may take a long time with the default values. - While there is no limit to the value that can be specified, note that putting very large values with C(gather_subset) set to meta choices like C(all) might lead to module or device API crash. - F5 recommends using C(data_increment) custom values in tandem with C(partition) and a specific C(gather_subset) value for best experience. type: int version_added: 1.22.0 version_added_collection: f5networks.f5_modules
apm_access_policies: contains: full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/foo_policy type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: foo_policy type: str description: Information about APM Access Policies. returned: When C(apm-access-policies) is specified in C(gather_subset). type: complex apm_access_profiles: contains: access_policy: description: - APM Access Policy attached to this Access Profile. returned: queried sample: foo_policy type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/foo_policy type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: foo_policy type: str description: Information about APM Access Profiles. returned: When C(apm-access-profiles) is specified in C(gather_subset). type: complex asm_policies: contains: active: description: - 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. returned: queried sample: true type: bool allowed_response_codes: description: - Lists the response status codes between 400 and 599 that the security profile considers legal. returned: queried sample: - '400' - '404' type: list application_language: description: - The language encoding for the web application. returned: queried sample: utf-8 type: str apply: description: - In TMOS 13.x and above, this setting indicates if an ASM policy has pending changes that need to be applied. returned: queried sample: true type: bool case_insensitive: description: - Indicates if the ASM policy treats file types, URLs, and parameters as case sensitive. returned: queried sample: true type: bool csrf_protection_enabled: description: - Specifies if CSRF protection is active on the ASM policy. returned: queried sample: true type: bool csrf_protection_expiration_time_in_seconds: description: - Specifies how long, in seconds, a configured CSRF token is valid before it expires. returned: queried sample: 600 type: int csrf_protection_ssl_only: description: - Specifies that only HTTPS URLs will be checked for CSRF protection. returned: queried sample: true type: bool csrf_urls: contains: csrf_url: description: - Specifies an URL to protect. returned: queried sample: - /foo.html type: str csrf_url_enforcement_action: description: - Indicates the action specified for the system to take when the URL entry matches. returned: queried sample: none type: str csrf_url_id: description: - Specifies the generated ID for the configured CSRF URL resource. returned: queried sample: l0Ckxe-7yHsXp8U5tTgbFQ type: str csrf_url_method: description: - Method for the specified URL. returned: queried sample: POST type: str csrf_url_parameters_list: description: - List of parameters to look for in a request when checking if the URL entry matches the request. returned: queried sample: - fooparam type: list csrf_url_required_parameters: description: - 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. returned: queried sample: ignore type: str csrf_url_wildcard_order: description: - Specifies the order in which the wildcard URLs are enforced. returned: queried sample: 1 type: str description: - 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. returned: queried type: complex custom_xff_headers: description: - List of custom XFF headers trusted by the system. returned: queried sample: asm-proxy1 type: str description: description: - Description of the resource. returned: queried sample: Significant Policy Description type: str disallowed_geolocations: description: - Displays countries that may not access the web application. returned: queried sample: Argentina type: str enforcement_mode: description: - Specifies whether blocking is active or inactive for the ASM policy. returned: queried sample: blocking type: str enforcement_readiness_period: description: - Period in days both security policy entities and attack signatures remain in staging mode before the system suggests to enforce them. returned: queried sample: 8 type: int full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/foo_policy type: str has_parent: description: - Indicates if the ASM policy is a child of another ASM policy. returned: queried sample: false type: bool inspect_http_uploads: description: - Specifies whether the system should inspect all HTTP uploads. returned: queried sample: true type: bool learning_mode: description: - Determine how the policy is built. returned: queried sample: manual type: str manual_virtual_servers: description: - The virtual servers that have Advanced LTM policy configuration which, in turn, have rule(s) built with ASM control actions enabled. returned: queried sample: - /Common/test_VS/ type: list mask_credit_card_numbers_in_request: description: - Indicates if the system masks credit card numbers. returned: queried sample: false type: bool maximum_cookie_header_length: description: - Maximum length of a cookie header name and value that the system processes. returned: queried sample: 8192 type: int maximum_http_header_length: description: - Maximum length of an HTTP header name and value that the system processes. returned: queried sample: 8192 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: foo_policy type: str path_parameter_handling: description: - Specifies how the system handles path parameters that are attached to path segments in URIs. returned: queried sample: ignore type: str place_signatures_in_staging: description: - Specifies if the system places new or updated signatures in staging for the number of days specified in the enforcement readiness period. returned: queried sample: false type: bool policy_id: description: - Generated ID of the ASM policy resource. returned: queried sample: l0Ckxe-7yHsXp8U5tTgbFQ type: str protocol_independent: description: - Indicates if the ASM policy differentiates between HTTP/WS and HTTPS/WSS URLs. returned: queried sample: false type: bool signature_staging: description: - Specifies if the staging feature is active on the ASM policy. returned: queried sample: true type: bool trigger_asm_irule_event: description: - Indicates if iRule event is enabled. returned: queried sample: disabled type: str trust_xff: description: - Indicates the system has confidence in an XFF (X-Forwarded-For) header in the request. returned: queried sample: true type: bool type: description: - The type of policy, can be C(Security) or C(Parent). returned: queried sample: security type: str use_dynamic_session_id_in_url: description: - Specifies how the security policy processes URLs that use dynamic sessions. returned: queried sample: false type: bool virtual_servers: description: - Virtual server or servers which have this policy assigned to them. returned: queried sample: - /Common/foo_VS/ type: list description: Detailed information for ASM policies present on device. returned: When C(asm-policies) is specified in C(gather_subset). sample: hash/dictionary of values type: complex asm_policy_stats: contains: parent_policies: description: - The total number of ASM parent policies on the device. returned: queried sample: 2 type: int policies: description: - The total number of ASM policies on the device. returned: queried sample: 3 type: int policies_active: description: - The number of ASM policies that are marked as active. From TMOS 13.x and above this setting equals to C(policies_attached). returned: queried sample: 3 type: int policies_attached: description: - The number of ASM policies that are attached to virtual servers. returned: queried sample: 1 type: int policies_inactive: description: - The number of ASM policies that are marked as inactive. From TMOS 13.x and above this setting equals to C(policies_unattached). returned: queried sample: 0 type: int policies_pending_changes: description: - The total number of ASM policies with pending changes on the device. returned: queried sample: 2 type: int policies_unattached: description: - The number of ASM policies that are not attached to a virtual server. returned: queried sample: 3 type: int description: Miscellaneous ASM policy related information. returned: When C(asm-policy-stats) is specified in C(gather_subset). sample: hash/dictionary of values type: complex asm_server_technologies: contains: id: description: - Displays the generated ID for the server technology resource. returned: queried sample: l0Ckxe-7yHsXp8U5tTgbFQ type: str server_technology_name: description: - Friendly name of the server technology resource. returned: queried sample: Wordpress type: str server_technology_references: contains: link: description: - A self link to an associated server technology. returned: queried sample: https://localhost/mgmt/tm/asm/server-technologies/NQG7CT02OBC2cQWbnP7T-A?ver=13.1.0 type: str description: - List of dictionaries containing API self links of the associated technology resources. returned: queried type: complex description: Detailed information for ASM server technologies present on the device. returned: When C(asm-server-technologies) is specified in C(gather_subset). sample: hash/dictionary of values type: complex asm_signature_sets: contains: assign_to_policy_by_default: description: - Indicates whether the system assigns this signature set to a new created security policy by default. returned: queried sample: true type: bool category: description: - Displays the category of the signature set. returned: queried sample: filter-based type: str default_alarm: description: - 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. returned: queried sample: true type: bool default_block: description: - When the security policy enforcement mode is Blocking, displays how the system treats requests that match a signature included in the signature set. returned: queried sample: true type: bool default_learn: description: - Displays whether the security policy learns all requests that match a signature that is included in the signature set. returned: queried sample: true type: bool id: description: - Displays the generated ID for the signature set resource. returned: queried sample: l0Ckxe-7yHsXp8U5tTgbFQ type: str is_user_defined: description: - Specifies this signature set was added by a user. returned: queried sample: false type: bool name: description: - Name of the signature set. returned: queried sample: WebSphere signatures type: str type: description: - The method used to select signatures to be a part of the signature set. returned: queried sample: filter-based type: str description: Detailed information for ASM signature sets present on device. returned: When C(asm-signature-sets) is specified in C(gather_subset). sample: hash/dictionary of values type: complex client_ssl_profiles: contains: alert_timeout: description: - Maximum time period, in seconds, to keep the SSL session active after an alert message is sent, or indefinite. returned: queried sample: 0 type: int allow_non_ssl: description: - Enables or disables non-SSL connections. returned: queried sample: true type: bool authenticate_depth: description: - Specifies the authenticate depth. This is the client certificate chain maximum traversal depth. returned: queried sample: 9 type: int authenticate_frequency: description: - Specifies how often the system authenticates a user. returned: queried sample: once type: str ca_file: description: - Specifies the certificate authority (CA) file name. returned: queried sample: /Common/default-ca.crt type: str cache_size: description: - Specifies the SSL session cache size. returned: queried sample: 262144 type: int cache_timeout: description: - Specifies the SSL session cache timeout value. returned: queried sample: 3600 type: int certificate_file: description: - Specifies the name of the certificate installed on the traffic management system for the purpose of terminating or initiating an SSL connection. returned: queried sample: /Common/default.crt type: str chain_file: description: - Specifies or builds a certificate chain file that a client can use to authenticate the profile. returned: queried sample: /Common/ca-chain.crt type: str ciphers: description: - Specifies a list of cipher names. returned: queried sample: - DEFAULT type: str crl_file: description: - Specifies the certificate revocation list file name. returned: queried sample: /Common/default.crl type: str description: description: - Description of the profile. returned: queried sample: My profile type: str forward_proxy_ca_certificate_file: description: - Specifies the name of the certificate file that is used as the certification authority certificate when SSL forward proxy feature is enabled. returned: queried type: str forward_proxy_ca_key_file: description: - Specifies the name of the key file that is used as the certification authority key when SSL forward proxy feature is enabled. returned: queried type: str forward_proxy_ca_passphrase: description: - Specifies the passphrase of the key file that is used as the certification authority key when SSL forward proxy feature is enabled. returned: queried type: str forward_proxy_certificate_extension_include: description: - Specifies the extensions of the web server certificates to be included in the generated certificates using SSL Forward Proxy. returned: queried sample: - basic-constraints - subject-alternative-name type: list forward_proxy_certificate_lifespan: description: - Specifies the lifespan of the certificate generated using the SSL forward proxy feature. returned: queried sample: 30 type: int forward_proxy_enabled: description: - Enables or disables SSL forward proxy feature. returned: queried sample: true type: bool forward_proxy_lookup_by_ipaddr_port: description: - Specifies whether to perform certificate look up by IP address and port number. returned: queried sample: false type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/bigip02.internal type: str handshake_timeout: description: - Specifies the handshake timeout in seconds. returned: queried sample: 10 type: int key_file: description: - Specifies the name of the key installed on the traffic management system for the purpose of terminating or initiating an SSL connection. returned: queried sample: /Common/default.key type: str modssl_methods: description: - Enables or disables ModSSL method emulation. returned: queried sample: false type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: bigip02.internal type: str parent: description: - Parent of the profile returned: queried sample: /Common/clientssl type: str peer_certification_mode: description: - Specifies the peer certificate mode. returned: queried sample: ignore type: str profile_mode_enabled: description: - Specifies the profile mode, which enables or disables SSL processing. returned: queried sample: true type: bool renegotiation: description: - Specifies whether renegotiations are enabled. returned: queried sample: true type: bool renegotiation_maximum_record_delay: description: - Maximum number of SSL records that the traffic management system can receive before it renegotiates an SSL session. returned: queried sample: 0 type: int renegotiation_period: description: - Number of seconds required to renegotiate an SSL session. returned: queried sample: 0 type: int retain_certificate: description: - APM module requires storing certificate in SSL session. When C(false), certificate will not be stored in SSL session. returned: queried sample: true type: bool secure_renegotiation_mode: description: - Specifies the secure renegotiation mode. returned: queried sample: require type: str server_name: description: - Specifies the server names to be matched with SNI (server name indication) extension information in ClientHello from a client connection. returned: queried sample: bigip01 type: str session_ticket: description: - Enables or disables session-ticket. returned: queried sample: false type: bool sni_default: description: - When C(true), 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. returned: queried sample: true type: bool sni_require: description: - When this option is C(true), a client connection that does not specify a known server name or does not support SNI extension will be rejected. returned: queried sample: false type: bool strict_resume: description: - Enables or disables strict-resume. returned: queried sample: true type: bool unclean_shutdown: description: - Whether to force the SSL profile to perform a clean shutdown of all SSL connections or not returned: queried sample: false type: bool description: Client SSL Profile related information. returned: When C(client-ssl-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex device_groups: contains: asm_sync_enabled: description: - Specifies whether to synchronize ASM configurations of device group members. returned: queried sample: true type: bool autosync_enabled: description: - Whether the device group automatically synchronizes configuration data to its members. returned: queried sample: false type: bool description: description: - Description of the device group. returned: queried sample: My device group type: str devices: description: - List of devices in the group. Devices are listed by their C(full_path). returned: queried sample: - /Common/bigip02.internal type: list full_load_on_sync: description: - Specifies the entire configuration for a device group is sent when configuration synchronization is performed. returned: queried sample: true type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/fasthttp type: str incremental_config_sync_size_maximum: description: - Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. returned: queried sample: 1024 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: fasthttp type: str network_failover_enabled: description: - Specifies whether network failover is used. returned: queried sample: true type: bool type: description: - Specifies the type of device group. returned: queried sample: sync-only type: str description: Device group related information. returned: When C(device-groups) is specified in C(gather_subset). sample: hash/dictionary of values type: complex devices: contains: active_modules: description: - The currently licensed and provisioned modules on the device. returned: queried sample: - DNS Services (LAB) - PSM, VE type: list base_mac_address: description: - Media Access Control address (MAC address) of the device. returned: queried sample: fa:16:3e:c3:42:6f type: str build: description: - The minor version information of the total product version. returned: queried sample: 0.0.1 type: str chassis_id: description: - Serial number of the device. returned: queried sample: 11111111-2222-3333-444444444444 type: str chassis_type: description: - Displays the chassis type. The possible values are C(individual) and C(viprion). returned: queried sample: individual type: str comment: description: - User comments about the device. returned: queried sample: My device type: str configsync_address: description: - IP address used for configuration synchronization. returned: queried sample: 10.10.10.10 type: str contact: description: - Administrator contact information. returned: queried sample: The User type: str description: description: - Description of the device. returned: queried sample: My device type: str edition: description: - Displays the software edition. returned: queried sample: Point Release 7 type: str failover_state: description: - Device failover state. returned: queried sample: active type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/bigip02.internal type: str hostname: description: - Device hostname returned: queried sample: bigip02.internal type: str location: description: - Specifies the physical location of the device. returned: queried sample: London type: str management_address: description: - IP address of the management interface. returned: queried sample: 3.3.3.3 type: str marketing_name: description: - Marketing name of the device platform. returned: queried sample: BIG-IP Virtual Edition type: str multicast_address: description: - Specifies the multicast IP address used for failover. returned: queried sample: 4.4.4.4 type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: bigip02.internal type: str optional_modules: description: - Modules that are available for the current platform, but are not currently licensed. returned: queried sample: - App Mode (TMSH Only, No Root/Bash) - BIG-IP VE, Multicast Routing type: list platform_id: description: - Displays the device platform identifier. returned: queried sample: Z100 type: str primary_mirror_address: description: - Specifies the IP address used for state mirroring. returned: queried sample: 5.5.5.5 type: str product: description: - Displays the software product name. returned: queried sample: BIG-IP type: str secondary_mirror_address: description: - Secondary IP address used for state mirroring. returned: queried sample: 2.2.2.2 type: str self: description: - Whether or not this device is the one that was queried for information. returned: queried sample: true type: bool software_version: description: - Displays the software version number. returned: queried sample: 13.1.0.7 type: str timelimited_modules: description: - Displays the licensed modules that are time-limited. returned: queried sample: - IP Intelligence, 3Yr, ... - PEM URL Filtering, 3Yr, ... type: list timezone: description: - Displays the time zone configured on the device. returned: queried sample: UTC type: str unicast_addresses: contains: effective_ip: description: - The IP address that peers can use to reach this unicast address IP. returned: queried sample: 5.4.3.5 type: str effective_port: description: - The port that peers can use to reach this unicast address. returned: queried sample: 1026 type: int ip: description: - The IP address the failover daemon will listen on for packets from its peers. returned: queried sample: 5.4.3.5 type: str port: description: - The IP port the failover daemon uses to accept packets from its peers. returned: queried sample: 1026 type: int description: - Specifies the entire set of unicast addresses used for failover. returned: queried type: complex description: Device related information. returned: When C(devices) is specified in C(gather_subset). sample: hash/dictionary of values type: complex external_monitors: contains: args: description: - Specifies any command-line arguments the script requires. returned: queried sample: arg1 arg2 arg3 type: str description: description: - Description of the resource. returned: queried sample: My monitor type: str destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. returned: queried sample: '*:*' type: str external_program: description: - Specifies the name of the file for the monitor to use. returned: queried sample: /Common/arg_example type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/external type: str interval: description: - 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. returned: queried sample: 5 type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to B(up) at the next successful monitor check. returned: queried sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: external type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: external type: str time_until_up: description: - Specifies the amount of time, in seconds, after the first successful response before a node is marked up. returned: queried sample: 0 type: int timeout: description: - Specifies the number of seconds the target has in which to respond to the monitor request. returned: queried sample: 16 type: int up_interval: description: - Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. returned: queried sample: 0 type: int variables: description: - Specifies any variables the script requires. sample: key1: val key_2: val 2 type: dict description: External monitor related information. returned: When C(external-monitors) is specified in C(gather_subset). sample: hash/dictionary of values type: complex fasthttp_profiles: contains: client_close_timeout: description: - 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. returned: queried sample: 5 type: int description: description: - Description of the resource. returned: queried sample: My profile type: str force_http_1_0_response: description: - When C(true), specifies the server sends responses to clients in the HTTP/1.0 format. returned: queried sample: false type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/fasthttp type: str http_1_1_close_workarounds: description: - When C(true), specifies the server uses workarounds for HTTP 1.1 close issues. returned: queried sample: false type: bool idle_timeout: description: - Length of time that a connection is idle (has no traffic) before the connection is eligible for deletion. returned: queried sample: 300 type: int insert_xforwarded_for: description: - Whether the system inserts the X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling. returned: queried sample: false type: bool maximum_header_size: description: - Maximum amount of HTTP header data the system buffers before making a load balancing decision. returned: queried sample: 32768 type: int maximum_requests: description: - Maximum number of requests the system can receive on a client-side connection, before the system closes the connection. returned: queried sample: 0 type: int maximum_segment_size_override: description: - Maximum segment size (MSS) override for server-side connections. returned: queried sample: 0 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: fasthttp type: str oneconnect_idle_timeout_override: description: - Number of seconds after which a server-side connection in a OneConnect pool is eligible for deletion, when the connection has no traffic. returned: queried sample: 0 type: int oneconnect_maximum_pool_size: description: - Maximum number of connections to a load balancing pool. returned: queried sample: 2048 type: int oneconnect_maximum_reuse: description: - Maximum number of times the system can re-use a current connection. returned: queried sample: 0 type: int oneconnect_minimum_pool_size: description: - Minimum number of connections to a load balancing pool. returned: queried sample: 0 type: int oneconnect_ramp_up_increment: description: - The increment in which the system makes additional connections available, when all available connections are in use. returned: queried sample: 4 type: int oneconnect_replenish': description: - When C(true), 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 C(minimum_pool_size) specified in the profile. returned: queried sample: true type: bool parent: description: - Profile from which this profile inherits settings. returned: queried sample: fasthttp type: str receive_window_size: description: - Amount of data the BIG-IP system can accept without acknowledging the server. returned: queried sample: 0 type: int request_header_insert: description: - A string the system inserts as a header in an HTTP request. If the header already exists, the system does not replace it. returned: queried sample: 'X-F5-Authentication: foo' type: str reset_on_timeout: description: - When C(true), specifies the system sends a reset packet (RST) in addition to deleting the connection, when a connection exceeds the idle timeout value. returned: queried sample: true type: bool server_close_timeout: description: - 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. returned: queried sample: 5 type: int server_sack: description: - Whether the BIG-IP system processes Selective ACK (Sack) packets in cookie responses from the server. returned: queried sample: false type: bool server_timestamp: description: - Whether the BIG-IP system processes timestamp request packets in cookie responses from the server. returned: queried sample: false type: bool unclean_shutdown: description: - How the system handles closing connections. Values provided may be C(enabled), C(disabled), or C(fast). returned: queried sample: enabled type: str description: FastHTTP profile related information. returned: When C(fasthttp-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex fastl4_profiles: contains: client_timeout: description: - 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. returned: queried sample: 30 type: int description: description: - Description of the resource. returned: queried sample: My profile type: str dont_fragment_flag: description: - Describes the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. - When C(pmtu), sets the outgoing IP Header DF bit based on the IP pmtu setting(tm.pathmtudiscovery). - When C(preserve), sets the outgoing packet's IP Header DF bit to be the same as the incoming IP Header DF bit. - When C(set), sets the outgoing packet's IP Header DF bit. - When C(clear), clears the outgoing packet's IP Header DF bit. returned: queried sample: pmtu type: str explicit_flow_migration: description: - Specifies whether to have the iRule code determine exactly when the FIX stream drops down to the ePVA hardware. returned: queried sample: true type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/fastl4 type: str generate_init_seq_number: description: - Specifies whether you want to generate TCP sequence numbers on all SYNs that conform with RFC1948, and allow timestamp recycling. returned: queried sample: true type: bool hardware_syn_cookie: description: - 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 C(syn-cookie-enable). returned: queried sample: false type: bool idle_timeout: description: - 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). - C(0) is equivalent to the TMUI value "immediate". - C(4294967295) is equivalent to the TMUI value "indefinite". returned: queried sample: 300 type: int ip_tos_to_client: description: - 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. returned: queried sample: 200 type: str ip_tos_to_server: description: - 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. returned: queried sample: pass-through type: str keep_alive_interval: description: - Specifies the keep-alive probe interval, in seconds. - A value of 0 indicates keep-alive is disabled. returned: queried sample: 10 type: int late_binding: description: - Specifies whether to enable or disable the intelligent selection of a back-end server pool. returned: queried sample: true type: bool link_qos_to_client: description: - 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. returned: queried sample: 7 type: int link_qos_to_server: description: - 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. returned: queried sample: 5 type: int loose_close: description: - Specifies the system closes a loosely-initiated connection when it receives the first FIN packet from either the client or the server. returned: queried sample: false type: bool loose_init: description: - Specifies the system initializes a connection when it receives any Transmission Control Protocol (TCP) packet, rather than requiring a SYN packet for connection initiation. returned: queried sample: true type: bool mss_override: description: - 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. - C(0) (zero), means the option is disabled. Otherwise, the value will be between 256 and 9162. returned: queried sample: 500 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: fastl4 type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: fastl4 type: str priority_to_client: description: - 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. returned: queried sample: 300 type: int priority_to_server: description: - 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. returned: queried sample: 200 type: int pva_acceleration: description: - Specifies the Packet Velocity(r) ASIC acceleration policy. returned: queried sample: full type: str pva_dynamic_client_packets: description: - Specifies the number of client packets before dynamic ePVA hardware re-offloading occurs. - Values are between 0 and 10. returned: queried sample: 8 type: int pva_dynamic_server_packets: description: - Specifies the number of server packets before dynamic ePVA hardware re-offloading occurs. - Values are between 0 and 10. returned: queried sample: 5 type: int pva_flow_aging: description: - Specifies if automatic aging from ePVA flow cache is enabled or not. returned: queried sample: true type: bool pva_flow_evict: description: - Specifies if this flow can be evicted upon hash collision with a new flow learn snoop request. returned: queried sample: false type: bool pva_offload_dynamic: description: - Specifies whether PVA flow dynamic offloading is enabled or not. returned: queried sample: true type: bool pva_offload_state: description: - Specifies at what stage the ePVA performs hardware offload. - When C(embryonic), applies at TCP CSYN or the first client UDP packet. - When C(establish), applies TCP 3WAY handshaking or UDP CS round trip are confirmed. returned: queried sample: embryonic type: str reassemble_fragments: description: - Specifies whether to reassemble fragments. returned: queried sample: true type: bool receive_window: description: - Specifies the window size to use, in bytes. - The maximum is 2^31 for window scale enabling. returned: queried sample: 1000 type: int reset_on_timeout: description: - Specifies whether you want to reset connections on timeout. returned: queried sample: true type: bool rtt_from_client: description: - Enables or disables the TCP timestamp options to measure the round trip time to the client. returned: queried sample: false type: bool rtt_from_server: description: - Enables or disables the TCP timestamp options to measure the round trip time to the server. returned: queried sample: true type: bool server_sack: description: - Specifies whether to support the server sack option in cookie responses by default. returned: queried sample: false type: bool server_timestamp: description: - Specifies whether to support the server timestamp option in cookie responses by default. returned: queried sample: true type: bool software_syn_cookie: description: - 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 C(syn_cookie_enabled). returned: queried sample: true type: bool strip_sack: description: - Specifies whether you want to block the TCP SackOK option from passing to the server on an initiating SYN. returned: queried sample: true type: bool syn_cookie_enabled: description: - Enables syn-cookies capability on this virtual server. returned: queried sample: false type: bool syn_cookie_mss: description: - Specifies a maximum segment size (MSS) for server connections when SYN Cookie is enabled. returned: queried sample: 2000 type: int syn_cookie_whitelist: description: - Specifies whether or not to use a SYN Cookie WhiteList when doing software SYN Cookies. returned: queried sample: false type: bool tcp_close_timeout: description: - Specifies a TCP close timeout in seconds. returned: queried sample: 100 type: int tcp_handshake_timeout: description: - Specifies a TCP handshake timeout in seconds. returned: queried sample: 5 type: int tcp_time_wait_timeout: description: - Specifies a TCP time_wait timeout in milliseconds. returned: queried sample: 60 type: int tcp_timestamp_mode: description: - Specifies how you want to handle the TCP timestamp. returned: queried sample: preserve type: str tcp_window_scale_mode: description: - Specifies how you want to handle the TCP window scale. returned: queried sample: preserve type: str timeout_recovery: description: - Specifies late binding timeout recovery mode. This is the action to take when late binding timeout occurs on a connection. - When C(disconnect), only the L7 iRule actions are acceptable to pick a server. - When C(fallback), the normal FastL4 load balancing methods are acceptable to pick a server. returned: queried sample: fallback type: str ttl_mode: description: - Describes the outgoing TCP packet's IP Header TTL mode. - When C(proxy), sets the outgoing IP Header TTL value to 255/64 for IPv4/IPv6 respectively. - When C(preserve), sets the outgoing IP Header TTL value to be same as the incoming IP Header TTL value. - When C(decrement), sets the outgoing IP Header TTL value to be one less than the incoming TTL value. - When C(set), sets the outgoing IP Header TTL value to a specific value (as specified by C(ttl_v4) or C(ttl_v6). returned: queried sample: preserve type: str ttl_v4: description: - Specifies the outgoing packet's IP Header TTL value for IPv4 traffic. - Maximum value is 255. returned: queried sample: 200 type: int ttl_v6: description: - Specify the outgoing packet's IP Header TTL value for IPv6. traffic. - Maximum value is 255. returned: queried sample: 300 type: int description: FastL4 profile related information. returned: When C(fastl4-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex gateway_icmp_monitors: contains: adaptive: description: - Whether adaptive response time monitoring is enabled for this monitor. returned: queried sample: false type: bool adaptive_divergence_type: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). returned: queried sample: relative type: str adaptive_divergence_value: description: - Specifies how far from mean latency each monitor probe is allowed to be. returned: queried sample: 25 type: int adaptive_limit: description: - Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. returned: queried sample: 200 type: int adaptive_sampling_timespan: description: - Specifies the size of the sliding window, in seconds, which records probe history. returned: queried sample: 300 type: int description: description: - Description of the resource. returned: queried sample: My monitor type: str destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. returned: queried sample: '*:*' type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/gateway_icmp type: str interval: description: - 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. returned: queried sample: 5 type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check. returned: queried sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: gateway_icmp type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: gateway_icmp type: str time_until_up: description: - Specifies the amount of time, in seconds, after the first successful response before a node is marked up. returned: queried sample: 0 type: int timeout: description: - Specifies the number of seconds the target has in which to respond to the monitor request. returned: queried sample: 16 type: int transparent: description: - Specifies whether the monitor operates in transparent mode. returned: queried sample: false type: bool up_interval: description: - Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. returned: queried sample: 0 type: int description: Gateway ICMP monitor related information. returned: When C(gateway-icmp-monitors) is specified in C(gather_subset). sample: hash/dictionary of values type: complex gtm_pools: contains: alternate_mode: description: - The load balancing mode the system uses to load balance name resolution requests among the members of the pool. returned: queried sample: drop-packet type: str disabled: description: - Specifies the pool is disabled. returned: queried type: bool dynamic_ratio: description: - Specifies whether the dynamic ratio load balancing algorithm is enabled for this pool. returned: queried sample: true type: bool enabled: description: - Specifies the pool is enabled. returned: queried type: bool fallback_mode: description: - 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. returned: queried type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/pool1 type: str load_balancing_mode: description: - Specifies the preferred load balancing mode the system uses to load balance requests across pool members. returned: queried type: str manual_resume: description: - Whether manual resume is enabled for this pool. returned: queried type: bool max_answers_returned: description: - Maximum number of available virtual servers the system lists in a response. returned: queried type: int members: description: - Lists of members (and their configurations) in the pool. returned: queried type: dict name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: pool1 type: str partition: description: - Partition on which the pool exists. returned: queried type: str qos_hit_ratio: description: - Weight of the Hit Ratio performance factor for the QoS dynamic load balancing method. returned: queried type: int qos_hops: description: - Weight of the Hops performance factor when load balancing mode or fallback mode is QoS. returned: queried type: int qos_kilobytes_second: description: - Weight assigned to the Kilobytes per Second performance factor when the load balancing option is QoS. returned: queried type: int qos_lcs: description: - Weight assigned to the Link Capacity performance factor when the load balacing option is QoS. returned: queried type: int qos_packet_rate: description: - Weight assigned to the Packet Rate performance factor when the load balacing option is QoS. returned: queried type: int qos_rtt: description: - Weight assigned to the Round Trip Time performance factor when the load balacing option is QoS. returned: queried type: int qos_topology: description: - Weight assigned to the Topology performance factor when the load balacing option is QoS. returned: queried type: int qos_vs_capacity: description: - Weight assigned to the Virtual Server performance factor when the load balacing option is QoS. returned: queried type: int qos_vs_score: description: - Weight assigned to the Virtual Server Score performance factor when the load balacing option is QoS. returned: queried type: int ttl: description: - Number of seconds the IP address, once found, is valid. returned: queried type: int verify_member_availability: description: - Whether or not the system verifies the availability of the members before sending a connection to them. returned: queried type: bool description: - 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. returned: When any of C(gtm-pools) or C(gtm-*-pools) is specified in C(gather_subset). sample: hash/dictionary of values type: complex gtm_servers: contains: addresses: description: - Specifies the server IP addresses. returned: queried type: dict datacenter: description: - Full name of the datacenter to which this server belongs. returned: queried type: str devices: description: - Specifies the names of the devices that represent this server. returned: queried type: dict disabled: description: - Specifies the server is disabled. returned: queried type: bool enabled: description: - Specifies the server is enabled. returned: queried type: bool expose_route_domains: description: - Allow the GTM server to auto-discover the LTM virtual servers from all route domains. returned: queried type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/server1 type: str iq_allow_path: description: - Whether the GTM uses this BIG-IP system to conduct a path probe before delegating traffic to it. returned: queried type: bool iq_allow_service_check: description: - Whether the GTM uses this BIG-IP system to conduct a service check probe before delegating traffic to it. returned: queried type: bool iq_allow_snmp: description: - Whether the GTM uses this BIG-IP system to conduct an SNMP probe before delegating traffic to it. returned: queried type: bool limit_cpu_usage: description: - For a server configured as a generic host, specifies the percent of CPU usage, otherwise this has no effect. returned: queried type: int limit_cpu_usage_status: description: - Whether C(limit_cpu_usage) is enabled for this server. returned: queried type: bool limit_max_bps: description: - Maximum allowable data throughput rate in bits per second for this server. returned: queried type: int limit_max_bps_status: description: - Whether C(limit_max_bps) is enabled for this server. returned: queried type: bool limit_max_connections: description: - Maximum number of concurrent connections, combined, for this server. returned: queried type: int limit_max_connections_status: description: - Whether C(limit_max_connections) is enabled for this server. type: bool limit_max_pps: description: - Maximum allowable data transfer rate for this server, in packets per second. returned: queried type: int limit_max_pps_status: description: - Whether C(limit_max_pps) is enabled for this server. returned: queried type: bool limit_mem_available: description: - 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. returned: queried type: int limit_mem_available_status: description: - Whether C(limit_mem_available) is enabled for this server. returned: queried type: bool link_discovery: description: - Specifies whether the system auto-discovers the links for this server. returned: queried type: str monitor_type: description: - Whether one or more monitors need to pass, or all monitors need to pass. returned: queried sample: and_list type: str monitors: description: - Specifies health monitors that the system uses to determine whether this server is available for load balancing. returned: queried sample: - /Common/https_443 - /Common/icmp type: list name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: server1 type: str prober_fallback: description: - The type of prober to use to monitor this server's resources when the preferred type is not available. returned: queried type: str prober_preference: description: - Specifies the type of prober to use to monitor this server's resources. returned: queried type: str product: description: - Specifies the server type. returned: queried type: str virtual_server_discovery: description: - Whether the system auto-discovers the virtual servers for this server. returned: queried type: str virtual_servers: description: - Specifies the virtual servers that are resources for this server. returned: queried type: dict description: - GTM server related information. returned: When C(gtm-servers) is specified in C(gather_subset). sample: hash/dictionary of values type: complex gtm_topology_regions: contains: full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/region1 type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: region1 type: str region_members: contains: continent: description: - The name of one of the seven continents in ISO format, along with the C(Unknown) setting. returned: when configured for the region member. sample: AF type: str country: description: - The country name returned as an ISO country code. - Valid country codes can be found here https://countrycode.org/. returned: when configured for the region member. sample: US type: str datacenter: description: - The name of a GTM data center already defined in the configuration. returned: when configured for the region member. sample: /Common/dc1 type: str geo_isp: description: - Specifies a geolocation ISP. returned: when configured for the region member. sample: /Common/FOO_ISP type: str isp: description: - Specifies an Internet service provider. returned: when configured for the region member. sample: /Common/AOL type: str negate: description: - Indicates if the region member is a C(IS-NOT) negative. In a BIG-IP configuration, the region members can be C(IS) or C(IS-NOT). returned: when configured for the region member. sample: true type: bool pool: description: - The name of a GTM pool already defined in the configuration. returned: when configured for the region member. sample: /Common/pool1 type: str region: description: - The name of region already defined in the configuration. returned: when configured for the region member. sample: /Common/region1 type: str state: description: - The state in a given country. returned: when configured for the region member. sample: AD/Sant Julia de Loria type: str subnet: description: - An IP address and network mask in the CIDR format. returned: when configured for the region member. sample: 10.10.10.0/24 type: str description: - The list of region members. sample: hash/dictionary of values type: complex description: GTM regions related information. returned: When C(gtm-topology-regions) is specified in C(gather_subset) sample: hash/dictionary of values type: complex gtm_wide_ips: contains: description: description: - Description of the Wide IP. returned: queried type: str disabled: description: - Whether the Wide IP is disabled. returned: queried type: bool enabled: description: - Whether the Wide IP is enabled. returned: queried type: bool failure_rcode: description: - Specifies the DNS RCODE used when C(failure_rcode_response) is C(true). returned: queried type: int failure_rcode_response: description: - When C(true), specifies the system returns a RCODE response to Wide IP requests after exhausting all load balancing methods. returned: queried type: bool failure_rcode_ttl: description: - Specifies the negative caching TTL of the SOA for the RCODE response. returned: queried type: int full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/wide1 type: str last_resort_pool: description: - Specifies which pool, as listed in Pool List, for the system to use as the last resort pool for the Wide IP. returned: queried type: str minimal_response: description: - Specifies the system forms the smallest allowable DNS response to a query. returned: queried type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: wide1 type: str persist_cidr_ipv4: description: - Specifies the number of bits the system uses to identify IPv4 addresses when persistence is enabled. returned: queried type: int persist_cidr_ipv6: description: - Specifies the number of bits the system uses to identify IPv6 addresses when persistence is enabled. returned: queried type: int pool_lb_mode: description: - Specifies the load balancing method used to select a pool in this Wide IP. returned: queried type: str pools: description: - Specifies the pools this Wide IP uses for load balancing. returned: queried type: dict ttl_persistence: description: - Specifies, in seconds, the length of time for which the persistence entry is valid. returned: queried type: int description: - 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. returned: When any of C(gtm-wide-ips) or C(gtm-*-wide-ips) is specified in C(gather_subset). sample: hash/dictionary of values type: complex http_monitors: contains: adaptive: description: - Whether adaptive response time monitoring is enabled for this monitor. returned: queried sample: false type: bool adaptive_divergence_type: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). returned: queried sample: relative type: str adaptive_divergence_value: description: - Specifies how far from mean latency each monitor probe is allowed to be. returned: queried sample: 25 type: int adaptive_limit: description: - Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. returned: queried sample: 200 type: int adaptive_sampling_timespan: description: - Specifies the size of the sliding window, in seconds, which records probe history. returned: queried sample: 300 type: int description: description: - Description of the resource. returned: queried sample: My monitor type: str destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. returned: queried sample: '*:*' type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/http type: str interval: description: - 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. returned: queried sample: 5 type: int ip_dscp: description: - Specifies the differentiated services code point (DSCP). returned: queried sample: 0 type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check. returned: queried sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: http type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: http type: str receive_disable_string: description: - 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. returned: queried sample: check disable string type: str receive_string: description: - Specifies the text string the monitor looks for in the returned resource. returned: queried sample: check string type: str reverse: description: - 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. returned: queried sample: false type: bool send_string: description: - Specifies the text string the monitor sends to the target object. returned: queried sample: GET /\r\n type: str time_until_up: description: - Specifies the amount of time, in seconds, after the first successful response before a node is marked up. returned: queried sample: 0 type: int timeout: description: - Specifies the number of seconds the target has in which to respond to the monitor request. returned: queried sample: 16 type: int transparent: description: - Specifies whether the monitor operates in transparent mode. returned: queried sample: false type: bool up_interval: description: - Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. returned: queried sample: 0 type: int username: description: - Specifies the username, if the monitored target requires authentication. returned: queried sample: user1 type: str description: HTTP monitor related information. returned: When C(http-monitors) is specified in C(gather_subset). sample: hash/dictionary of values type: complex http_profiles: contains: accept_xff: description: - 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. returned: queried sample: true type: bool allow_truncated_redirects: description: - 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 C(false), the system will silently drop the invalid HTTP. returned: queried sample: false type: bool default_connect_handling: description: - Specifies the behavior of the proxy service when handling outbound requests. returned: queried sample: deny type: str description: description: - Description of the resource. returned: queried sample: My profile type: str excess_client_headers: description: - Specifies the pass-through behavior when the C(max_header_count) value is exceeded by the client. - When C(reject), the system rejects the connection. returned: queried sample: reject type: str excess_server_headers: description: - Specifies the pass-through behavior when C(max_header_count) value is exceeded by the server. - When C(reject), the system rejects the connection. returned: queried sample: reject type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/http type: str hsts_enabled: description: - When C(true), enables the HTTP Strict Transport Security settings. returned: queried sample: true type: bool hsts_include_subdomains: description: - When C(true), applies the HSTS policy to the HSTS host and its subdomains. returned: queried sample: true type: bool insert_xforwarded_for: description: - When C(true), specifies the system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling. returned: queried sample: false type: bool known_methods: description: - 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 C(known_methods) list, the BIG-IP system applies the C(unknown_method) setting to manage that traffic. returned: queried sample: - CONNECT - DELETE - '...' type: list lws_max_columns: description: - Specifies the maximum column width for any given line, when inserting an HTTP header in an HTTP request. returned: queried sample: 80 type: int max_header_count: description: - Specifies the maximum number of headers the system supports. returned: queried sample: 64 type: int max_header_size: description: - Specifies the maximum size, in bytes, the system allows for all HTTP request headers combined, including the request line. returned: queried sample: 32768 type: int max_requests: description: - Specifies the number of requests the system accepts on a per-connection basis. returned: queried sample: 0 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: http type: str onconnect_transformations: description: - When C(true), specifies the system performs HTTP header transformations for the purpose of keeping connections open. returned: queried sample: true type: bool oversize_client_headers: description: - Specifies the pass-through behavior when the C(max_header_size) value is exceeded by the client. returned: queried sample: reject type: str oversize_server_headers: description: - Specifies the pass-through behavior when the C(max_header_size) value is exceeded by the server. returned: queried sample: reject type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: http type: str pipeline_action: description: - Enables or disables HTTP/1.1 pipelining. returned: queried sample: allow type: str proxy_mode: description: - Specifies the proxy mode for this profile. Either reverse, explicit, or transparent. returned: queried sample: reverse type: str redirect_rewrite: description: - Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses. returned: queried sample: none type: str request_chunking: description: - Specifies how the system handles HTTP content that is chunked by a client. returned: queried sample: preserve type: str response_chunking: description: - Specifies how the system handles HTTP content that is chunked by a server. returned: queried sample: selective type: str server_agent_name: description: - Specifies the string used as the server name in traffic generated by LTM. returned: queried sample: BigIP type: str sflow_poll_interval: description: - The maximum interval in seconds between two pollings. returned: queried sample: 0 type: int sflow_sampling_rate: description: - Specifies the ratio of packets observed to the samples generated. returned: queried sample: 0 type: int unknown_method: description: - Specifies the behavior (allow, reject, or pass through) when an unknown HTTP method is parsed. returned: queried sample: allow type: str via_request: description: - Specifies whether to Remove, Preserve, or Append Via headers included in a client request to an origin web server. returned: queried sample: preserve type: str via_response: description: - Specifies whether to Remove, Preserve, or Append Via headers included in an origin web server response to a client. returned: queried sample: preserve type: str description: HTTP profile related information. returned: When C(http-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex https_monitors: contains: adaptive: description: - Whether adaptive response time monitoring is enabled for this monitor. returned: queried sample: false type: bool adaptive_divergence_type: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). returned: queried sample: relative type: str adaptive_divergence_value: description: - Specifies how far from mean latency each monitor probe is allowed to be. returned: queried sample: 25 type: int adaptive_limit: description: - Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. returned: queried sample: 200 type: int adaptive_sampling_timespan: description: - Specifies the size of the sliding window, in seconds, which records probe history. returned: queried sample: 300 type: int description: description: - Description of the resource. returned: queried sample: My monitor type: str destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. returned: queried sample: '*:*' type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/http type: str interval: description: - 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. returned: queried sample: 5 type: int ip_dscp: description: - Specifies the differentiated services code point (DSCP). returned: queried sample: 0 type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. returned: queried sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: http type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: http type: str receive_disable_string: description: - 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. returned: queried sample: check disable string type: str receive_string: description: - Specifies the text string the monitor looks for in the returned resource. returned: queried sample: check string type: str reverse: description: - 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. returned: queried sample: false type: bool send_string: description: - Specifies the text string the monitor sends to the target object. returned: queried sample: GET /\r\n type: str ssl_profile: description: - Specifies the SSL profile to use for the HTTPS monitor. returned: queried sample: /Common/serverssl type: str time_until_up: description: - Specifies the amount of time, in seconds, after the first successful response before a node is marked up. returned: queried sample: 0 type: int timeout: description: - Specifies the number of seconds the target has in which to respond to the monitor request. returned: queried sample: 16 type: int transparent: description: - Specifies whether the monitor operates in transparent mode. returned: queried sample: false type: bool up_interval: description: - Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. returned: queried sample: 0 type: int username: description: - Specifies the username, if the monitored target requires authentication. returned: queried sample: user1 type: str description: HTTPS monitor related information. returned: When C(https-monitors) is specified in C(gather_subset). sample: hash/dictionary of values type: complex iapp_services: contains: description: description: - Description of the service. returned: queried sample: My service type: str device_group: description: - The device group the iApp service is part of. returned: queried sample: /Common/dg1 type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/service1 type: str inherited_device_group: description: - Whether the device group is inherited or not. returned: queried sample: true type: bool inherited_traffic_group: description: - Whether the traffic group is inherited or not. returned: queried sample: true type: bool lists: description: - List of the lists data used to create the service. returned: queried sample: - name: irules__irules - value: [] - '...' type: list metadata: description: - List of the metadata data used to create the service. returned: queried sample: - name: var1 - persist: 'true' - '...' type: list name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: service1 type: str strict_updates: description: - Whether strict updates are enabled or not. returned: queried sample: true type: bool tables: description: - List of the tabular data used to create the service. returned: queried sample: - name: basic__snatpool_members - '...' type: list template_modified: description: - Whether template the service is based on is modified from its default value, or not. returned: queried sample: true type: bool traffic_group: description: - Traffic group the service is a part of. returned: queried sample: /Common/tg type: str variables: description: - List of the variable data used to create the service. returned: queried sample: - name: afm__policy - encrypted: 'no' - value: /#no_not_use# - '...' type: list description: iApp v1 service related information. returned: When C(iapp-services) is specified in C(gather_subset). sample: hash/dictionary of values type: complex icmp_monitors: contains: adaptive: description: - Whether adaptive response time monitoring is enabled for this monitor. returned: queried sample: false type: bool adaptive_divergence_type: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). returned: queried sample: relative type: str adaptive_divergence_value: description: - Specifies how far from mean latency each monitor probe is allowed to be. returned: queried sample: 25 type: int adaptive_limit: description: - Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. returned: queried sample: 200 type: int adaptive_sampling_timespan: description: - Specifies the size of the sliding window, in seconds, which records probe history. returned: queried sample: 300 type: int description: description: - Description of the resource. returned: queried sample: My monitor type: str destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. returned: queried sample: '*:*' type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/icmp type: str interval: description: - 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. returned: queried sample: 5 type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check. sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: icmp type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: icmp type: str time_until_up: description: - Specifies the amount of time, in seconds, after the first successful response before a node is marked up. returned: queried sample: 0 type: int timeout: description: - Specifies the number of seconds the target has in which to respond to the monitor request. returned: queried sample: 16 type: int transparent: description: - Specifies whether the monitor operates in transparent mode. returned: queried sample: false type: bool up_interval: description: - Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. returned: queried sample: 0 type: int description: ICMP monitor related information. returned: When C(icmp-monitors) is specified in C(gather_subset). sample: hash/dictionary of values type: complex interfaces: contains: active_media_type: description: - Displays the current media setting for the interface. returned: queried sample: 100TX-FD type: str bundle: description: - The bundle capability on the port. returned: queried sample: not-supported type: str bundle_speed: description: - The bundle-speed on the port when bundle capability is enabled. returned: queried sample: 100G type: str description: description: - Description of the interface. returned: queried sample: My interface type: str enabled: description: - Whether the interface is enabled or not. returned: queried sample: true type: bool flow_control: description: - Specifies how the system controls the sending of PAUSE frames for flow control. returned: queried sample: tx-rx type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/interface1 type: str if_index: description: - The index assigned to this interface. returned: queried sample: 32 type: int lldp_admin: description: - Sets the sending or receiving of LLDP packets on that interface. Should be one of C(disable), C(txonly), C(rxonly) or C(txrx). returned: queried sample: txonly type: str mac_address: description: - Displays the 6-byte ethernet address in non-case-sensitive hexadecimal colon notation. returned: queried sample: 00:0b:09:88:00:9a type: str media_sfp: description: - The settings for an SFP (pluggable) interface. returned: queried sample: auto type: str mtu: description: - Displays the Maximum Transmission Unit (MTU) of the interface, which is the maximum number of bytes in a frame without IP fragmentation. returned: queried sample: 1500 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: interface1 type: str prefer_port: description: - Indicates which side of a combo port the interface uses, if both sides of the port have the potential for external links. returned: queried sample: sfp type: str sflow_poll_interval: description: - Specifies the maximum interval in seconds between two pollings. returned: queried sample: 0 type: int sflow_poll_interval_global: description: - Specifies whether the global interface poll-interval setting overrides the object-level poll-interval setting. returned: queried sample: true type: bool stp_auto_edge_port: description: - STP edge port detection. returned: queried sample: true type: bool stp_enabled: description: - Whether STP is enabled or not. returned: queried sample: false type: bool stp_link_type: description: - Specifies the STP link type for the interface. returned: queried sample: auto type: str description: Interface related information. returned: When C(interfaces) is specified in C(gather_subset). sample: hash/dictionary of values type: complex irules: contains: checksum: description: - Checksum of the iRule as calculated by BIG-IP. returned: queried sample: d41d8cd98f00b204e9800998ecf8427e type: str definition: description: - The actual definition of the iRule. returned: queried sample: when HTTP_REQUEST ... type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/irule1 type: str ignore_verification: description: - Whether the verification of the iRule should be ignored or not. returned: queried sample: false type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: irule1 type: str signature: description: - The calculated signature of the iRule. returned: queried sample: WsYy2M6xMqvosIKIEH/FSsvhtWMe6xKOA6i7f... type: str description: iRule related information. returned: When C(irules) is specified in C(gather_subset). sample: hash/dictionary of values type: complex license: contains: active_modules: description: - Specifies the modules that are activated by the license. returned: queried sample: - featureModules: '{}' key: A123456-9876543 - '...' type: list license_end_date: description: - Specifies the date on which the license is no longer valid. returned: queried sample: 2022/12/30 type: str license_start_date: description: - Specifies the date on whichthe license was issued. returned: queried sample: 2022/11/21 type: str licensed_on_date: description: - Specifies the date on which the license was activated. returned: queried sample: 2022/11/22 type: str licensed_version: description: - Specifies the version of the device that is using this license. returned: queried sample: 15.1.2 type: str max_permitted_version: description: - Specifies the maximum version to which this license can be applied. returned: queried sample: 18.*.* type: str min_permitted_version: description: - Specifies the minimum version to which this license can be applied. returned: queried sample: 5.*.* type: str platform_id: description: - Specifies the platform id for which the license was activated. returned: queried sample: Z100k type: str registration_key: description: - Specifies the registration key associated with the license. returned: queried sample: XXXX-XXXX-XXXX-XXXX-XXXX type: str service_check_date: description: - Specifies the last date the license was last activated. returned: queried sample: 2022/11/30 type: str description: License related info. returned: When C(license) is specified in C(gather_subset). sample: hash/dictionary of values type: complex ltm_policies: contains: controls: description: - Aspects of the system controlled by this policy. returned: queried sample: - forwarding type: list description: description: - Description of the policy. returned: queried sample: My policy type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/policy1 type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: policy1 type: str requires: description: - Aspects of the system required by this policy. returned: queried sample: - http type: list rules: contains: actions: contains: http_reply: description: - Indicates if the action affects a reply to a given HTTP request. returned: when defined in the action. sample: true type: bool location: description: - This action will come from the given location. returned: when defined in the action. sample: tcl:https://[getfield [HTTP::host] \":\" 1][HTTP::uri] type: str redirect: description: - This action will redirect a request. returned: when defined in the action. sample: false type: bool request: description: - This policy action is performed on connection requests. returned: when defined in the action. sample: false type: bool description: - The actions the policy will take when a match is encountered. returned: when actions are defined in the rule. sample: hash/dictionary of values type: complex conditions: contains: address: description: - This condition matches on a TCP address. returned: when defined in the condition. sample: false type: bool all: description: - Matches all. returned: when defined in the condition. sample: true type: bool case_insensitive: description: - Specifies the value matched on is case insensitive. returned: when defined in the condition. sample: false type: bool case_sensitive: description: - Specifies the value matched on is case sensitive. returned: when defined in the condition. sample: true type: bool contains_string: description: - Specifies the value matches if it contains a certain string. returned: when defined in the condition. sample: true type: bool datagroup: description: - This condition matches on an HTTP URI. returned: when defined in the condition. sample: /Common/policy_using_datagroup type: str external: description: - Specifies the value matched on is from the external side of a connection. returned: when defined in the condition. sample: true type: bool http_basic_auth: description: - This condition matches on basic HTTP authorization. returned: when defined in the condition. sample: false type: bool http_host: description: - This condition matches on an HTTP host. returned: when defined in the condition. sample: true type: bool http_uri: description: - This condition matches on an HTTP URI. returned: when defined in the condition. sample: false type: bool matches: description: - This condition matches on an address. returned: when defined in the condition. sample: false type: bool proxy_connect: description: - Specifies the value matched on is proxyConnect. returned: when defined in the condition. sample: false type: bool proxy_request: description: - Specifies the value matched on is proxyRequest. returned: when defined in the condition. sample: false type: bool remote: description: - Specifies the value matched on is remote. returned: when defined in the condition. sample: false type: bool request: description: - This policy matches on a request. returned: when defined in the condition. sample: true type: bool tcp: description: - This condition matches on TCP parameters. returned: when defined in the condition. sample: false type: bool username: description: - Matches on a username. returned: when defined in the condition. sample: true type: bool values: description: - The specified values will be matched on. returned: when defined in the condition. sample: - foo.bar.com - baz.cool.com type: list description: - The conditions a policy will match on. returned: when conditions are defined in the rule. sample: hash/dictionary of values type: complex description: - List of LTM (Local Traffic Manager) policy rules. returned: when rules are defined in the policy. sample: hash/dictionary of values type: complex status: description: - Indicates published or draft policy status. returned: queried sample: draft type: str strategy: description: - The match strategy for the policy. returned: queried sample: /Common/first-match type: str description: List of LTM (Local Traffic Manager) policies. returned: When C(ltm-policies) is specified in C(gather_subset). sample: hash/dictionary of values type: complex ltm_pools: contains: active_member_count: description: - The number of active pool members in the pool. returned: queried sample: 3 type: int all_avg_queue_entry_age: description: - Average queue entry age, for both the pool and its members. returned: queried sample: 5 type: int all_max_queue_entry_age_ever: description: - Maximum queue entry age ever, for both the pool and its members. returned: queried sample: 2 type: int all_max_queue_entry_age_recently: description: - Maximum queue entry age recently, for both the pool and its members. returned: queried sample: 5 type: int all_num_connections_queued_now: description: - Number of connections queued now, for both the pool and its members. returned: queried sample: 20 type: int all_num_connections_serviced: description: - Number of connections serviced, for both the pool and its members. returned: queried sample: 15 type: int all_queue_head_entry_age: description: - Queue head entry age, for both the pool and its members. returned: queried sample: 4 type: int allow_nat: description: - Whether NATs are automatically enabled or disabled for any connections using this pool. returned: queried sample: true type: bool allow_snat: description: - Whether SNATs are automatically enabled or disabled for any connections using this pool. returned: queried sample: true type: bool availability_status: description: - The availability of the pool. returned: queried sample: offline type: str available_member_count: description: - The number of available pool members in the pool. returned: queried sample: 4 type: int client_ip_tos: description: - 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 C(0) to C(255), or be set to C(pass-through) or C(mimic). returned: queried sample: pass-through type: str client_link_qos: description: - 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 C(0) to C(7), or be set to C(pass-through). returned: queried sample: pass-through type: str current_sessions: description: - Current sessions. returned: queried sample: 2 type: int description: description: - Description of the pool. returned: queried sample: my pool type: str enabled_status: description: - The enabled status of the pool. returned: queried sample: enabled type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/pool1 type: str ignore_persisted_weight: description: - Specifies not to count the weight of persisted connections on pool members when making load balancing decisions. returned: queried sample: false type: bool lb_method: description: - Load balancing method used by the pool. returned: queried sample: round-robin type: str member_count: description: - Total number of members in the pool. returned: queried sample: 50 type: int members: contains: address: description: IP address of the pool member. returned: queried sample: 1.1.1.1 type: str connection_limit: description: The maximum number of concurrent connections allowed for a pool member. returned: queried sample: 0 type: int description: description: The description of the pool member. returned: queried sample: pool member 1 type: str dynamic_ratio: description: - A range of numbers you want the system to use in conjunction with the ratio load balancing method. returned: queried sample: 1 type: int encapsulation_profile: description: - The encapsulation profile to use for the pool member. returned: queried sample: ip4ip4 type: str ephemeral: description: - Whether the node backing the pool member is ephemeral or not. returned: queried sample: true type: bool fqdn_autopopulate: description: - Whether the node should scale to the IP address set returned by DNS. returned: queried sample: true type: bool full_path: description: - Full name of the resource as known to the BIG-IP. - Includes the port in the name. returned: queried sample: /Common/member:80 type: str inherit_profile: description: - Whether the pool member inherits the encapsulation profile from the parent pool. returned: queried sample: false type: bool logging: description: - Whether the monitor applied should log its actions. returned: queried sample: false type: bool monitors: description: - The Monitors active on the pool member. Monitor names are in their "full_path" form. returned: queried sample: - /Common/http type: list name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: member:80 type: str partition: description: - Partition the member exists on. returned: queried sample: Common type: str priority_group: description: - The priority group within the pool for this pool member. returned: queried sample: 0 type: int rate_limit: description: - The maximum number of connections per second allowed for a pool member. returned: queried sample: false type: bool ratio: description: - The weight of the pool for load balancing purposes. returned: queried sample: 1 type: int session: description: - Enables or disables the pool member for new sessions. returned: queried sample: monitor-enabled type: str state: description: - Controls the state of the pool member, overriding any monitors. returned: queried sample: down type: str description: List of LTM (Local Traffic Manager) pools. returned: when members exist in the pool. type: complex metadata: description: - Dictionary of arbitrary key/value pairs set on the pool. returned: queried sample: hash/dictionary of values type: dict minimum_active_members: description: - Whether the system load balances traffic according to the priority number assigned to the pool member. - This parameter is identical to C(priority_group_activation) and is just an alias for it. returned: queried sample: 2 type: int minimum_up_members: description: - The minimum number of pool members that must be up. returned: queried sample: 1 type: int minimum_up_members_action: description: - The action to take if the C(minimum_up_members_checking) is enabled and the number of active pool members falls below the number specified in C(minimum_up_members). returned: queried sample: failover type: str minimum_up_members_checking: description: - Enables or disables the C(minimum_up_members) feature. returned: queried sample: false type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: pool1 type: str pool_avg_queue_entry_age: description: - Average queue entry age, for the pool only. returned: queried sample: 5 type: int pool_max_queue_entry_age_ever: description: - Maximum queue entry age ever, for the pool only. returned: queried sample: 2 type: int pool_max_queue_entry_age_recently: description: - Maximum queue entry age recently, for the pool only. returned: queried sample: 5 type: int pool_num_connections_queued_now: description: - Number of connections queued now, for the pool only. returned: queried sample: 20 type: int pool_num_connections_serviced: description: - Number of connections serviced, for the pool only. returned: queried sample: 15 type: int pool_queue_head_entry_age: description: - Queue head entry age, for the pool only. returned: queried sample: 4 type: int priority_group_activation: description: - Whether the system load balances traffic according to the priority number assigned to the pool member. - This parameter is identical to C(minimum_active_members) and is just an alias for it. returned: queried sample: 2 type: int queue_depth_limit: description: - The maximum number of connections that may simultaneously be queued to go to any member of this pool. returned: queried sample: 3 type: int queue_on_connection_limit: description: - Enable or disable queuing connections when pool member or node connection limits are reached. returned: queried sample: true type: bool queue_time_limit: description: - Specifies the maximum time, in milliseconds, a connection will remain queued. returned: queried sample: 0 type: int real_session: description: - The actual REST API value for the C(session) attribute. - This is different from the C(state) return value, as the return value can be considered a generalization of all available sessions, instead of the specific value of the session. returned: queried sample: monitor-enabled type: str real_state: description: - The actual REST API value for the C(state) attribute. - This is different from the C(state) return value, as the return value can be considered a generalization of all available states, instead of the specific value of the state. returned: queried sample: up type: str reselect_tries: description: - The number of times the system tries to contact a pool member after a passive failure. returned: queried sample: 0 type: int server_ip_tos: description: - The Type of Service (ToS) level to use when sending packets to a server. returned: queried sample: pass-through type: str server_link_qos: description: - The Quality of Service (QoS) level to use when sending packets to a server. returned: queried sample: pass-through type: str server_side_bits_in: description: - Number of server-side ingress bits. returned: queried sample: 1000 type: int server_side_bits_out: description: - Number of server-side egress bits. returned: queried sample: 200 type: int server_side_current_connections: description: - Number of current connections server-side. returned: queried sample: 300 type: int server_side_max_connections: description: - Maximum number of connections server-side. returned: queried sample: 40 type: int server_side_pkts_in: description: - Number of server-side ingress packets. returned: queried sample: 1098384 type: int server_side_pkts_out: description: - Number of server-side egress packets. returned: queried sample: 3484734 type: int server_side_total_connections: description: - Total number of server-side connections. returned: queried sample: 24 type: int service_down_action: description: - The action to take if the service specified in the pool is marked down. returned: queried sample: none type: str slow_ramp_time: description: - 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. returned: queried sample: 10 type: int status_reason: description: - If there is a problem with the status of the pool, it is reported here. returned: queried sample: The children pool member(s) are down. type: str total_requests: description: - Total requests. returned: queried sample: 8 type: int description: List of LTM (Local Traffic Manager) pools. returned: When C(ltm-pools) is specified in C(gather_subset). sample: hash/dictionary of values type: complex management_routes: contains: description: description: - User defined description of the route. returned: queried sample: route-1-external type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/default type: str gateway: description: - The gateway IP address through which the system forwards packets to the destination. returned: queried sample: 192.168.0.1 type: str mtu: description: - The maximum transmission unit for the management interface. returned: queried sample: 0 type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: default type: str network: description: - The destination subnet and netmask, also specified as default or default-inet6. returned: queried sample: default type: str description: Management route related information. returned: When C(management-routes) is specified in C(gather_subset). sample: hash/dictionary of values type: complex nodes: contains: address: description: - IP address of the node. returned: queried sample: 2.3.4.5 type: str availability_status: description: - The availability of the node. returned: queried sample: offline type: str connection_limit: description: - Maximum number of connections the node can handle. returned: queried sample: 100 type: int description: description: - Description of the node. returned: queried sample: My node type: str dynamic_ratio: description: - Dynamic ratio number for the node used when doing C(Dynamic Ratio) load balancing. returned: queried sample: 200 type: int enabled_status: description: - The enabled status of the node. returned: queried sample: enabled type: str fqdn_address_type: description: - The address family of the automatically created ephemeral nodes. returned: queried sample: ipv4 type: str fqdn_auto_populate: description: - Indicates if the system automatically creates ephemeral nodes using DNS discovered IPs. returned: queried sample: true type: bool fqdn_down_interval: description: - The interval in which a query occurs when the DNS server is down. returned: queried sample: 15 type: int fqdn_name: description: - FQDN name of the node. returned: queried sample: sample.host.foo.com type: str fqdn_up_interval: description: - The interval at which a query occurs when the DNS server is up. returned: queried sample: 3600 type: int full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/5.6.7.8 type: str monitor_rule: description: - A string representation of the full monitor rule. returned: queried sample: /Common/https_443 and /Common/icmp type: str monitor_status: description: - Status of the node as reported by the monitor(s) associated with it. - This value is also used in determining node C(state). returned: queried sample: down type: str monitor_type: description: - The C(monitor_type) field related to the C(bigip_node) module, for this nodes monitors. returned: queried sample: and_list type: str monitors: description: - A list of the monitors identified in the C(monitor_rule). returned: queried sample: - /Common/https_443 - /Common/icmp type: list name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: 5.6.7.8 type: str rate_limit: description: - Maximum number of connections per second allowed for the node. returned: queried sample: 1000 type: int ratio: description: - Fixed size ratio used for node during C(Ratio) load balancing. returned: queried sample: 10 type: int session_status: description: - This value is also used in determining node C(state). returned: queried sample: enabled type: str status_reason: description: - If there is a problem with the status of the node, it is reported here. returned: queried sample: /Common/https_443 No successful responses received... type: str description: Node related information. returned: When C(nodes) is specified in C(gather_subset). sample: hash/dictionary of values type: complex oneconnect_profiles: contains: description: description: - Description of the resource. returned: queried sample: My profile type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/oneconnect type: str idle_timeout_override: description: - Specifies the number of seconds that a connection is idle before the connection flow is eligible for deletion. returned: queried sample: 1000 type: int limit_type: description: - When C(none), simultaneous in-flight requests and responses over TCP connections to a pool member are counted toward the limit. - When C(idle), idle connections will be dropped as the TCP connection limit is reached. - When C(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. returned: queried sample: idle type: str max_age: description: - Specifies the maximum age, in seconds, of a connection in the connection reuse pool. returned: queried sample: 100 type: int max_reuse: description: - Specifies the maximum number of times a server connection can be reused. returned: queried sample: 1000 type: int max_size: description: - 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. returned: queried sample: 1000 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: oneconnect type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: oneconnect type: str share_pools: description: - Indicates connections may be shared not only within a virtual server, but also among similar virtual servers. returned: queried sample: true type: bool source_mask: description: - Specifies a source IP mask. - If no mask is provided, the value C(any6) is used. returned: queried sample: 255.255.255.0 type: str description: OneConnect profile related information. returned: When C(oneconnect-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex partitions: contains: default_route_domain: description: - ID of the route domain that is associated with the IP addresses that reside in the partition. returned: queried sample: 0 type: int description: description: - Description of the partition. returned: queried sample: Tenant 1 type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: Common type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: Common type: str description: Partition related information. returned: When C(partitions) is specified in C(gather_subset). sample: hash/dictionary of values type: complex provision_info: contains: cpu_ratio: description: - Ratio of CPU allocated to this module. - Only relevant if C(level) was specified as C(custom). Otherwise, this value will be reported as C(0). returned: queried sample: 0 type: int disk_ratio: description: - Ratio of disk allocated to this module. - Only relevant if C(level) was specified as C(custom). Otherwise, this value will be reported as C(0). returned: queried sample: 0 type: int full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: asm type: str level: description: - Provisioned level of the module on BIG-IP. - Valid return values can include C(none), C(minimum), C(nominal), C(dedicated) and C(custom). returned: queried sample: 0 type: int memory_ratio: description: - Ratio of memory allocated to this module. - Only relevant if C(level) was specified as C(custom). Otherwise, this value will be reported as C(0). returned: queried sample: 0 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: asm type: str description: Module provisioning related information. returned: When C(provision-info) is specified in C(gather_subset). sample: hash/dictionary of values type: complex remote_syslog: contains: servers: contains: local_ip: description: The local IP address of the remote syslog server. returned: queried sample: 10.10.10.10 type: str name: description: Name of remote syslog server as configured on the system. returned: queried sample: /Common/foobar1 type: str remote_host: description: The IP address or hostname of the remote syslog server. returned: queried sample: 192.168.1.1 type: str remote_port: description: Remote port of the remote syslog server. returned: queried sample: 514 type: int description: Configured remote syslog servers. returned: queried sample: hash/dictionary of values type: complex description: Remote Syslog related information. returned: When C(remote-syslog) is specified in C(gather_subset). sample: hash/dictionary of values type: complex route_domains: contains: bwc_policy: description: - The bandwidth controller for the route domain. returned: queried sample: /Common/foo type: str connection_limit: description: - The new connection limit for the route domain. returned: queried sample: 100 type: int description: description: - Description of the Route Domain. returned: queried sample: My route domain type: str flow_eviction_policy: description: - The new eviction policy to use with this route domain. returned: queried sample: /Common/default-eviction-policy type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/rd1 type: str id: description: - The unique identifying integer representing the route domain. returned: queried sample: 10 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: rd1 type: str parent: description: - The route domain the system searches when it cannot find a route in the configured domain. returned: queried sample: 0 type: str routing_protocol: description: - List of routing protocols applied to the route domain. returned: queried sample: - bfd - bgp type: list service_policy: description: - The new service policy to use with this route domain. returned: queried sample: /Common-my-service-policy type: str strict: description: - The new strict isolation setting. returned: queried sample: enabled type: str vlans: description: - List of new VLANs the route domain is applied to. returned: queried sample: - /Common/http-tunnel - /Common/socks-tunnel type: list description: Route domain related information. returned: When C(self-ips) is specified in C(gather_subset). sample: hash/dictionary of values type: complex self_ips: contains: allow_access_list: description: - 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 C(0). returned: queried sample: - tcp:80 - egp:0 type: list description: description: - Description of the Self IP. returned: queried sample: My self-ip type: str floating: description: - Whether the Self IP is a floating address or not. returned: queried sample: true type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/self1 type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: self1 type: str netmask: description: - Netmask portion of the IP address, in dotted notation. returned: queried sample: 255.255.255.0 type: str netmask_cidr: description: - Netmask portion of the IP address, in CIDR notation. returned: queried sample: 24 type: int service_policy: description: - Service policy assigned to the Self IP. returned: queried sample: /Common/service1 type: str traffic_group: description: - Traffic group the Self IP is associated with. returned: queried sample: /Common/traffic-group-local-only type: str traffic_group_inherited: description: - Whether or not the traffic group is inherited. returned: queried sample: false type: bool vlan: description: - VLAN associated with the Self IP. returned: queried sample: /Common/vlan1 type: str description: Self IP related information. returned: When C(self-ips) is specified in C(gather_subset). sample: hash/dictionary of values type: complex server_ssl_profiles: contains: alert_timeout: description: - Maximum time period in seconds to keep the SSL session active after an alert message is sent, or indefinite. returned: queried sample: 100 type: str allow_expired_crl: description: - Use the specified CRL file, even if it has expired. returned: queried sample: true type: bool authenticate_depth: description: - The client certificate chain maximum traversal depth returned: queried sample: 9 type: int authenticate_name: description: - Common Name (CN) embedded in a server certificate. - The system authenticates a server based on the specified CN. returned: queried sample: foo type: str authentication_frequency: description: - Specifies the frequency of authentication. returned: queried sample: once type: str bypass_on_client_cert_fail: description: - Enables or disables SSL forward proxy bypass on failing to get client certificate that the server asks for. returned: queried sample: true type: bool bypass_on_handshake_alert: description: - Enables or disables SSL forward proxy bypass on receiving handshake_failure, protocol_version or unsupported_extension alert message during the serverside SSL handshake. returned: queried sample: false type: bool c3d_ca_cert: description: - Name of the certificate file used as the certification authority certificate when SSL client certificate constrained delegation is enabled. returned: queried sample: /Common/cacert.crt type: str c3d_ca_key: description: - Name of the key file used as the certification authority key when SSL client certificate constrained delegation is enabled. returned: queried sample: /Common/default.key type: str c3d_cert_extension_includes: description: - Extensions of the client certificates to be included in the generated certificates using SSL client certificate constrained delegation. returned: queried sample: - basic-constraints - extended-key-usage - '...' type: list c3d_cert_lifespan: description: - Lifespan of the certificate generated using the SSL client certificate constrained delegation. returned: queried sample: 24 type: int ca_file: description: - Certificate authority file name. returned: queried sample: default.crt type: str cache_size: description: - The SSL session cache size. returned: queried sample: 262144 type: int cache_timeout: description: - The SSL session cache timeout value, which is the usable lifetime seconds of negotiated SSL session IDs. returned: queried sample: 86400 type: int cert: description: - The name of the certificate installed on the traffic management system for the purpose of terminating or initiating an SSL connection. returned: queried sample: /Common/default.crt type: str chain: description: - Specifies or builds a certificate chain file that a client can use to authenticate the profile. returned: queried sample: /Common/default.crt type: str cipher_group: description: - Specifies a cipher group. returned: queried type: str ciphers: description: - Specifies a cipher name. returned: queried sample: DEFAULT type: str crl_file: description: - Specifies the certificate revocation list file name. returned: queried type: str description: description: - Description of the resource. returned: queried sample: My profile type: str expire_cert_response_control: description: - Specifies the BIGIP action when the server certificate has expired. returned: queried sample: drop type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: serverssl type: str generic_alert: description: - Enables or disables generic-alert. returned: queried sample: true type: bool handshake_timeout: description: - Specifies the handshake timeout in seconds. returned: queried sample: 10 type: str key: description: - Specifies the name of the key installed on the traffic management system for the purpose of terminating or initiating an SSL connection. returned: queried sample: /Common/default.key type: str max_active_handshakes: description: - Specifies the maximum number of allowed active SSL handshakes. returned: queried sample: 100 type: str mod_ssl_methods: description: - Enables or disables ModSSL methods. returned: queried sample: true type: bool mode: description: - Enables or disables SSL processing. returned: queried sample: false type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: serverssl type: str ocsp: description: - Specifies the name of the OCSP profile for validating the status of the server certificate. returned: queried type: str options: description: - Enables options, including some industry-related workarounds. returned: queried sample: - netscape-reuse-cipher-change-bug - dont-insert-empty-fragments type: list parent: description: - Profile from which this profile inherits settings. returned: queried sample: serverssl type: str peer_cert_mode: description: - Specifies the peer certificate mode. returned: queried sample: ignore type: str proxy_ssl: description: - Allows further modification of application traffic within an SSL tunnel while still allowing the server to perform necessary authorization, authentication, auditing steps. returned: queried sample: true type: bool proxy_ssl_passthrough: description: - Allows Proxy SSL to passthrough the traffic when ciphersuite negotiated between the client and server is not supported. returned: queried sample: true type: bool renegotiate_period: description: - Number of seconds from the initial connect time after which the system renegotiates an SSL session. returned: queried sample: indefinite type: str renegotiate_size: description: - Specifies a throughput size of SSL renegotiation, in megabytes. returned: queried sample: indefinite type: str renegotiation: description: - Whether renegotiations are enabled. returned: queried sample: true type: bool retain_certificate: description: - APM module requires storing certificates in the SSL session. When C(false), a certificate will not be stored in the SSL session. returned: queried sample: false type: bool secure_renegotiation: description: - Specifies the secure renegotiation mode. returned: queried sample: require type: str server_name: description: - Server name to be included in the SNI (server name indication) extension during SSL handshake in ClientHello. returned: queried type: str session_mirroring: description: - Enables or disables the mirroring of sessions to the high availability peer. returned: queried sample: true type: bool session_ticket: description: - Enables or disables session-ticket. returned: queried sample: false type: bool sni_default: description: - When C(true), 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. returned: queried sample: true type: bool sni_require: description: - When C(true), connections to a server that do not support SNI extension will be rejected. returned: queried sample: false type: bool ssl_c3d: description: - Enables or disables SSL Client certificate constrained delegation. returned: queried sample: true type: bool ssl_forward_proxy_bypass: description: - Enables or disables the ssl-forward-proxy-bypass feature. returned: queried sample: true type: bool ssl_forward_proxy_enabled: description: - Enables or disables the ssl-forward-proxy feature. returned: queried sample: false type: bool ssl_sign_hash: description: - 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. returned: queried sample: sha1 type: str strict_resume: description: - Enables or disables the resumption of SSL sessions after an unclean shutdown. returned: queried sample: false type: bool unclean_shutdown: description: - Specifies, when C(true), 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. returned: queried sample: true type: bool untrusted_cert_response_control: description: - Specifies the BIG-IP action when the server certificate has an untrusted CA. returned: queried sample: drop type: str description: Server SSL related information. returned: When C(server-ssl-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex software_hotfixes: contains: build: description: - Build number of the image. - This is usually a sub-string of the C(name). returned: queried sample: 3.0.1679 type: str checksum: description: - MD5 checksum of the image. - Note that this is the checksum stored inside the ISO. It is not the actual checksum of the ISO. returned: queried sample: df1ec715d2089d0fa54c0c4284656a98 type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso type: str id: description: - ID component of the image. - This is usually a sub-string of the C(name). returned: queried sample: HF3 type: str name: description: - Name of the image. returned: queried sample: Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso type: str product: description: - Product contained in the ISO. returned: queried sample: BIG-IP type: str title: description: - Human friendly name of the image. returned: queried sample: Hotfix Version 3.0.1679 type: str verified: description: - Specifies whether the system has verified this image. returned: queried sample: true type: bool version: description: - Version of software contained in the image. - This is a sub-string of the C(name). returned: queried sample: 13.0.0 type: str description: List of software hotfixes. returned: When C(software-hotfixes) is specified in C(gather_subset). sample: hash/dictionary of values type: complex software_images: contains: build: description: - Build number of the image. - This is usually a sub-string of the C(name). returned: queried sample: 0.0.1 type: str build_date: description: - Date of the build. returned: queried sample: '2018-05-05T15:26:30' type: str checksum: description: - MD5 checksum of the image. - Note that this is the checksum stored inside the ISO. It is not the actual checksum of the ISO. returned: queried sample: df1ec715d2089d0fa54c0c4284656a98 type: str file_size: description: - Size of the image, in megabytes. returned: queried sample: 1938 type: int full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: BIGIP-13.1.0.7-0.0.1.iso type: str last_modified: description: - Last modified date of the ISO. returned: queried sample: '2018-05-05T15:26:30' type: str name: description: - Name of the image. returned: queried sample: BIGIP-13.1.0.7-0.0.1.iso type: str product: description: - Product contained in the ISO. returned: queried sample: BIG-IP type: str verified: description: - Whether or not the system has verified this image. returned: queried sample: true type: bool version: description: - Version of software contained in the image. - This is a sub-string of the C(name). returned: queried sample: 13.1.0.7 type: str description: List of software images. returned: When C(software-images) is specified in C(gather_subset). sample: hash/dictionary of values type: complex software_volumes: contains: active: description: - Whether the volume is currently active or not. - An active volume contains the currently running version of software. returned: queried sample: true type: bool base_build: description: - 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. returned: queried sample: 0.0.6 type: str build: description: - Build version of the software installed in the volume. returned: queried sample: 0.0.6 type: str default_boot_location: description: - Whether this volume is the default boot location or not. returned: queried sample: true type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: HD1.1 type: str name: description: - Relative name of the resource in the BIG-IP. - This usually matches the C(full_name). returned: queried sample: HD1.1 type: str product: description: - The F5 product installed in this slot. - This should always be BIG-IP. returned: queried sample: BIG-IP type: str status: description: - Status of the software installed, or being installed, in the volume. - When C(complete), indicates the software has completed installing. returned: queried sample: complete type: str version: description: - Version of software installed in the volume, excluding the C(build) number. returned: queried sample: 13.1.0.4 type: str description: List of software volumes. returned: When C(software-volumes) is specified in C(gather_subset). sample: hash/dictionary of values type: complex ssl_certs: contains: create_time: description: - Specifies the time the file-object was created. returned: queried sample: '2018-05-15T21:11:15Z' type: str expiration_date: description: - Specifies a string representation of the expiration date of the certificate. returned: queried sample: Aug 13 21:21:29 2031 GMT type: str expiration_timestamp: description: - Specifies the date this certificate expires. Stored as a POSIX time. returned: queried sample: 1944422489 type: int fingerprint: description: - Displays the SHA-256 fingerprint of the certificate. returned: queried sample: SHA256/88:A3:05:...:59:01:EA:5D:B0 type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/cert1 type: str is_bundle: description: - Specifies whether the certificate file is a bundle (that is, whether it contains more than one certificate). returned: queried sample: false type: bool issuer: description: - Specifies X509 information of the certificate's issuer. returned: queried sample: emailAddress=support@f5.com,...CN=support.f5.com, type: str key_size: description: - Specifies the size (in bytes) of the file associated with this file object. returned: queried sample: 2048 type: int key_type: description: - Specifies the type of cryptographic key associated with this certificate. returned: queried sample: rsa-private type: str last_update_time: description: - Specifies the last time the file-object was updated/modified. returned: queried sample: '2018-05-15T21:11:15Z' type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: cert1 type: str serial_no: description: - Specifies certificate's serial number returned: queried sample: '1234567890' type: str sha1_checksum: description: - SHA1 checksum of the certificate. returned: queried sample: 1306e84e1e6a2da53816cefe1f684b80d6be1e3e type: str subject: description: - Specifies X509 information of the certificate's subject. returned: queried sample: emailAddress=support@f5.com,CN=... type: str subject_alternative_name: description: - Displays the Subject Alternative Name for the certificate. - The X509v3 Subject Alternative Name is embedded in the certificate for X509 extension purposes. returned: queried sample: DNS:www.example.com, DNS:www.example.internal.net type: str system_path: description: - Path on the BIG-IP where the cert can be found. returned: queried sample: /config/ssl/ssl.crt/f5-irule.crt type: str description: SSL certificate related information. returned: When C(ssl-certs) is specified in C(gather_subset). sample: hash/dictionary of values type: complex ssl_keys: contains: full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/key1 type: str key_size: description: - Specifies the size of the cryptographic key associated with this file object, in bits. returned: queried sample: 2048 type: int key_type: description: - Specifies the cryptographic type of the key. That is, which algorithm this key is compatible with. returned: queried sample: rsa-private type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: key1 type: str security_type: description: - Specifies the type of security used to handle or store the key. returned: queried sample: normal type: str sha1_checksum: description: - The SHA1 checksum of the key. returned: queried sample: 1fcf7de3dd8e834d613099d8e10b2060cd9ecc9f type: str system_path: description: - The path on the filesystem where the key is stored. returned: queried sample: /config/ssl/ssl.key/default.key type: str description: SSL certificate related information. returned: When C(ssl-keys) is specified in C(gather_subset). sample: hash/dictionary of values type: complex sync_status: contains: color: description: - Sync status color. - Eg. red, blue, green, yellow returned: queried sample: red type: str details: description: - A list of all details provided for the current sync-status of the device returned: queried sample: - Optional action: Add a device to the trust domain type: list mode: description: - Device operation mode (high-availability, standalone) returned: queried sample: - high-availability - standalone type: str recommended_action: description: - The next recommended action to take on the current sync-status. - This field might be empty. returned: queried sample: Synchronize bigip-a.example.com to group some-device-group type: str status: description: - Synchronization Status returned: queried sample: - Changes Pending - In Sync - Standalone - Disconnected type: str summary: description: The configuration synchronization status summary returned: queried sample: - The device group is awaiting the initial config sync - There is a possible change conflict between ... type: str description: - 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. returned: When C(sync-status) is specified in C(gather_subset). sample: hash/dictionary of values type: complex system_db: contains: default: description: - Default value of the key. returned: queried sample: www.f5.com type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: vendor.wwwurl type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: vendor.wwwurl type: str scf_config: description: - Whether the database key would be found in an SCF config or not. returned: queried sample: false type: str value: description: - The value of the key. returned: queried sample: www.f5.com type: str value_range: description: - The accepted range of values for the key. returned: queried sample: string type: str description: System DB related information. returned: When C(system-db) is specified in C(gather_subset). sample: hash/dictionary of values type: complex system_info: contains: base_mac_address: description: - Media Access Control address (MAC address) of the device. returned: queried sample: fa:16:3e:c3:42:6f type: str chassis_serial: description: - Serial of the chassis. returned: queried sample: 11111111-2222-3333-444444444444 type: str hardware_information: contains: model: description: - The model of the hardware. returned: queried sample: Virtual Disk type: str name: description: - The name of the hardware. returned: queried sample: HD1 type: str type: description: - The type of hardware. returned: queried sample: physical-disk type: str versions: contains: name: description: - Name of the property. returned: queried sample: Size type: str version: description: - Value of the property. returned: queried sample: 154.00G type: str description: - Hardware specific properties. returned: queried type: complex description: - Information related to the hardware (drives and CPUs) of the system. returned: queried type: complex host_board_part_revision: description: - Revision of the host board. returned: queried type: str host_board_serial: description: - Serial of the host board. returned: queried type: str marketing_name: description: - Marketing name of the device platform. returned: queried sample: BIG-IP Virtual Edition type: str package_edition: description: - Displays the software edition. returned: queried sample: Point Release 7 type: str package_version: description: - A string combining the C(product_build) and C(product_build_date). returned: queried sample: Build 0.0.1 - Tue May 15 15:26:30 PDT 2018 type: str platform: description: - Platform identifier. returned: queried sample: Z100 type: str product_build: description: - Build version of the release version. returned: queried sample: 0.0.1 type: str product_build_date: description: - Human readable build date. returned: queried sample: Tue May 15 15:26:30 PDT 2018 type: str product_built: description: - UNIX timestamp of when the product was built. returned: queried sample: 180515152630 type: int product_changelist: description: - Changelist the product branches from. returned: queried sample: 2557198 type: int product_code: description: - Code identifying the product. returned: queried sample: BIG-IP type: str product_jobid: description: - ID of the job that built the product version. returned: queried sample: 1012030 type: int product_version: description: - Major product version of the running software. returned: queried sample: 13.1.0.7 type: str switch_board_part_revision: description: - Switch board revision. returned: queried type: str switch_board_serial: description: - Serial of the switch board. returned: queried type: str time: contains: day: description: - The current day of the month, in numeric form. returned: queried sample: 7 type: int hour: description: - The current hour of the day in 24-hour format. returned: queried sample: 18 type: int minute: description: - The current minute of the hour. returned: queried sample: 16 type: int month: description: - The current month, in numeric form. returned: queried sample: 6 type: int second: description: - The current second of the minute. returned: queried sample: 51 type: int year: description: - The current year in 4-digit format. returned: queried sample: 2018 type: int description: - Mapping of the current time information to specific time-named keys. returned: queried type: complex uptime: description: - Time since the system booted, in seconds. returned: queried sample: 603202 type: int description: Traffic group related information. returned: When C(traffic-groups) is specified in C(gather_subset). sample: hash/dictionary of values type: complex tcp_half_open_monitors: contains: description: description: - Description of the resource. returned: queried sample: My monitor type: str destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. returned: queried sample: '*:*' type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/tcp type: str interval: description: - 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. returned: queried sample: 5 type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. returned: queried sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: tcp type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: tcp type: str time_until_up: description: - Specifies the amount of time, in seconds, after the first successful response before a node is marked up. returned: queried sample: 0 type: int timeout: description: - Specifies the number of seconds the target has in which to respond to the monitor request. returned: queried sample: 16 type: int transparent: description: - Specifies whether the monitor operates in transparent mode. returned: queried sample: false type: bool up_interval: description: - Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. returned: queried sample: 0 type: int description: TCP Half-open monitor related information. returned: When C(tcp-half-open-monitors) is specified in C(gather_subset). sample: hash/dictionary of values type: complex tcp_monitors: contains: adaptive: description: - Whether adaptive response time monitoring is enabled for this monitor. returned: queried sample: false type: bool adaptive_divergence_type: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). returned: queried sample: relative type: str adaptive_divergence_value: description: - Specifies how far from mean latency each monitor probe is allowed to be. returned: queried sample: 25 type: int adaptive_limit: description: - Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. returned: queried sample: 200 type: int adaptive_sampling_timespan: description: - Specifies the size of the sliding window, in seconds, which records probe history. returned: queried sample: 300 type: int description: description: - Description of the resource. returned: queried sample: My monitor type: str destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. returned: queried sample: '*:*' type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/tcp type: str interval: description: - 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. returned: queried sample: 5 type: int ip_dscp: description: - Specifies the differentiated services code point (DSCP). returned: queried sample: 0 type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. returned: queried sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: tcp type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: tcp type: str reverse: description: - 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. returned: queried sample: false type: bool time_until_up: description: - Specifies the amount of time, in seconds, after the first successful response before a node is marked up. returned: queried sample: 0 type: int timeout: description: - Specifies the number of seconds the target has in which to respond to the monitor request. returned: queried sample: 16 type: int transparent: description: - Specifies whether the monitor operates in transparent mode. returned: queried sample: false type: bool up_interval: description: - Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. returned: queried sample: 0 type: int description: TCP monitor related information. returned: When C(tcp-monitors) is specified in C(gather_subset). sample: hash/dictionary of values type: complex tcp_profiles: contains: abc: description: - Appropriate Byte Counting (RFC 3465) - When C(true), increases the congestion window by basing the amount to increase on the number of previously unacknowledged bytes that each ACK covers. returned: queried sample: true type: bool ack_on_push: description: - When C(true), specifies significantly improved performance to Microsoft Windows and MacOS peers who are writing out on a very small send buffer. returned: queried sample: false type: bool auto_proxy_buffer: description: - When C(true), specifies the system uses the network measurements to set the optimal proxy buffer size. returned: queried sample: true type: bool auto_receive_window: description: - When C(true), specifies the system uses the network measurements to set the optimal receive window size. returned: queried sample: false type: bool auto_send_buffer: description: - When C(true), specifies the system uses the network measurements to set the optimal send buffer size. returned: queried sample: true type: bool close_wait: description: - 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 C(immediate) or C(indefinite). - When C(immediate), specifies the TCP connection closes immediately after entering the LAST-ACK state. - When C(indefinite), specifies that TCP connections in the LAST-ACK state do not close until they meet the maximum retransmissions timeout. returned: queried sample: indefinite type: str congestion_control: description: - Specifies the algorithm to use to share network resources among competing users to reduce congestion. - Return values may include, C(high-speed), C(cdg), C(chd), C(none), C(cubic), C(illinois), C(new-reno), C(reno), C(scalable), C(vegas), C(westwood), and C(woodside). returned: queried sample: high-speed type: str congestion_metrics_cache: description: - When C(true), 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. returned: queried sample: true type: bool congestion_metrics_cache_timeout: description: - Specifies the number of seconds for which entries in the congestion metrics cache are valid. returned: queried sample: 0 type: int deferred_accept: description: - When C(true), 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. returned: queried sample: true type: bool delay_window_control: description: - 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. returned: queried sample: true type: bool delayed_acks: description: - When checked (enabled), specifies the system can send fewer than one ACK (acknowledgment) segment per data segment received. returned: queried sample: true type: bool description: description: - Description of the resource. returned: queried sample: My profile type: str dont_fragment_flag: description: - Specifies the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. returned: queried sample: pmtu type: str dsack: description: - D-SACK (RFC 2883) - When C(true), specifies the use of the selective ACK (SACK) option to acknowledge duplicate segments. returned: queried sample: true type: bool early_retransmit: description: - When C(true), 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. returned: queried sample: true type: bool enhanced_loss_recovery: description: - Specifies whether the system uses enhanced loss recovery to recover from random packet losses more effectively. returned: queried sample: true type: bool explicit_congestion_notification: description: - When C(true), 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. returned: queried sample: true type: bool fast_open: description: - When C(true), specifies, the system supports TCP Fast Open, which reduces latency by allowing a client to include the first packet of data with the SYN returned: queried sample: true type: bool fast_open_cookie_expiration: description: - Specifies the number of seconds that a Fast Open Cookie delivered to a client is valid for SYN packets from that client. returned: queried sample: 1000 type: int fin_wait_1: description: - Specifies the length of time that a TCP connection is in the FIN-WAIT-1 or CLOSING state before quitting. returned: queried sample: indefinite type: str fin_wait_2: description: - Specifies the length of time a TCP connection is in the FIN-WAIT-2 state before quitting. returned: queried sample: 100 type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: tcp type: str idle_timeout: description: - Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion. returned: queried sample: 300 type: str initial_congestion_window_size: description: - Specifies the initial congestion window size for connections to this destination. returned: queried sample: 3 type: int initial_receive_window_size: description: - Specifies the initial receive window size for connections to this destination. returned: queried sample: 5 type: int ip_tos: description: - Specifies the L3 Type of Service (ToS) level the system inserts in TCP packets destined for clients. returned: queried sample: mimic type: str keep_alive_interval: description: - Specifies how frequently the system sends data over an idle TCP connection, to determine whether the connection is still valid. returned: queried sample: 50 type: str limited_transmit_recovery: description: - When C(true), 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. returned: queried sample: true type: bool link_qos: description: - Specifies the L2 Quality of Service (QoS) level the system inserts in TCP packets destined for clients. returned: queried sample: 200 type: str max_segment_retrans: description: - Specifies the maximum number of times that the system resends data segments. returned: queried sample: 8 type: int max_segment_size: description: - Specifies the largest amount of data the system can receive in a single TCP segment, not including the TCP and IP headers. returned: queried sample: 1460 type: int max_syn_retrans: description: - Specifies the maximum number of times the system resends a SYN packet when it does not receive a corresponding SYN-ACK. returned: queried sample: 3 type: int md5_signature: description: - When C(true), specifies to use RFC2385 TCP-MD5 signatures to protect TCP traffic against intermediate tampering. returned: queried sample: true type: bool minimum_rto: description: - Specifies the minimum length of time the system waits for acknowledgements of data sent before resending the data. returned: queried sample: 1000 type: int mptcp_checksum: description: - When C(true), specifies the system calculates the checksum for MPTCP connections. returned: queried sample: false type: bool mptcp_checksum_verify: description: - When C(true), specifies the system verifies the checksum for MPTCP connections. returned: queried sample: false type: bool mptcp_fallback: description: - Specifies an action on fallback, that is, when MPTCP transitions to regular TCP, because something prevents MPTCP from working correctly. returned: queried sample: reset type: str mptcp_fast_join: description: - When C(true), 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. returned: queried sample: false type: bool mptcp_idle_timeout: description: - Specifies the number of seconds that an MPTCP connection is idle before the connection is eligible for deletion. returned: queried sample: 300 type: int mptcp_join_max: description: - Specifies the highest number of MPTCP connections that can join to a given connection. returned: queried sample: 5 type: int mptcp_make_after_break: description: - Specifies make-after-break functionality is supported, allowing for long-lived MPTCP sessions. returned: queried sample: false type: bool mptcp_no_join_dss_ack: description: - When checked (enabled), specifies no DSS option is sent on the JOIN ACK. returned: queried sample: false type: bool mptcp_retransmit_min: description: - Specifies the minimum value (in msec) of the retransmission timer for these MPTCP flows. returned: queried sample: 1000 type: int mptcp_rto_max: description: - Specifies the number of RTOs (retransmission timeouts) before declaring the subflow dead. returned: queried sample: 5 type: int mptcp_subflow_max: description: - Specifies the maximum number of MPTCP subflows for a single flow. returned: queried sample: 6 type: int mptcp_timeout: description: - Specifies, in seconds, the timeout value to discard long-lived sessions that do not have an active flow. returned: queried sample: 3600 type: int multipath_tcp: description: - When C(true), specifies the system accepts Multipath TCP (MPTCP) connections, which allow multiple client-side flows to connect to a single server-side flow. returned: queried sample: true type: bool nagle_algorithm: description: - Specifies whether the system applies Nagle's algorithm to reduce the number of short segments on the network. returned: queried sample: false type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: /Common/tcp type: str parent: description: - Profile from which this profile inherits settings. returned: queried sample: tcp type: str pkt_loss_ignore_burst: description: - Specifies the probability of performing congestion control when multiple packets are lost, even if the Packet Loss Ignore Rate was not exceeded. returned: queried sample: 0 type: int pkt_loss_ignore_rate: description: - Specifies the threshold of packets lost per million at which the system performs congestion control. returned: queried sample: 0 type: int proxy_buffer_high: description: - Specifies the proxy buffer level, in bytes, at which the receive window is closed. returned: queried sample: 49152 type: int proxy_buffer_low: description: - Specifies the proxy buffer level, in bytes, at which the receive window is opened. returned: queried sample: 32768 type: int proxy_max_segment: description: - When C(true), specifies the system attempts to advertise the same maximum segment size (MSS) to the server-side connection as that of the client-side connection. returned: queried sample: true type: bool proxy_options: description: - When C(true), specifies the system advertises an option (such as time stamps) to the server only when the option is negotiated with the client. returned: queried sample: false type: bool push_flag: description: - Specifies how the BIG-IP system receives ACKs. returned: queried sample: default type: str rate_pace: description: - When C(true), specifies the system paces the egress packets to avoid dropping packets, allowing for optimum goodput. returned: queried sample: true type: bool rate_pace_max_rate: description: - Specifies the maximum rate in bytes per second to which the system paces TCP data transmission. returned: queried sample: 0 type: int receive_window: description: - Specifies the maximum advertised RECEIVE window size. returned: queried sample: 65535 type: int reset_on_timeout: description: - When C(true), specifies the system sends a reset packet (RST) in addition to deleting the connection, when a connection exceeds the idle timeout value. returned: queried sample: true type: bool retransmit_threshold: description: - Specifies the number of duplicate ACKs (retransmit threshold) to start fast recovery. returned: queried sample: 3 type: int selective_acks: description: - When C(true), specifies the system processes data using selective ACKs (SACKs) whenever possible, to improve system performance. returned: queried sample: true type: bool selective_nack: description: - When C(true), specifies the system processes data using a selective negative acknowledgment (SNACK) whenever possible, to improve system performance. returned: queried sample: true type: bool send_buffer: description: - Specifies the SEND window size. returned: queried sample: 65535 type: int slow_start: description: - When C(true), 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. returned: queried sample: true type: bool syn_cookie_enable: description: - 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. returned: queried sample: true type: bool syn_cookie_white_list: description: - Specifies whether or not to use a SYN Cookie WhiteList when doing software SYN Cookies. returned: queried sample: false type: bool syn_retrans_to_base: description: - Specifies the initial RTO (Retransmission TimeOut) base multiplier for SYN retransmissions. returned: queried sample: 3000 type: int tail_loss_probe: description: - When C(true), specifies the system uses Tail Loss Probe to reduce the number of retransmission timeouts. returned: queried sample: true type: bool time_to_live: description: - Specifies the outgoing TCP packet's IP Header TTL mode. returned: queried sample: proxy type: str time_to_live_v4: description: - Specifies the outgoing packet's IP Header TTL value for IPv4 traffic. returned: queried sample: 255 type: int time_to_live_v6: description: - Specifies the outgoing packet's IP Header TTL value for IPv6 traffic. returned: queried sample: 64 type: int time_wait: description: - Specifies the length of time that a TCP connection remains in the TIME-WAIT state before entering the CLOSED state. returned: queried sample: 2000 type: str time_wait_recycle: description: - When C(true), specifies that connections in a TIME-WAIT state are reused when the system receives a SYN packet, indicating a request for a new connection. returned: queried sample: true type: bool timestamps: description: - When C(true), specifies the system uses the timestamps extension for TCP (as specified in RFC 1323) to enhance high-speed network performance. returned: queried sample: true type: bool verified_accept: description: - When C(true), specifies the system can actually communicate with the server before establishing a client connection. returned: queried sample: true type: bool zero_window_timeout: description: - Specifies the timeout in milliseconds for terminating a connection with an effective zero length TCP transmit window. returned: queried sample: 2000 type: str description: TCP profile related information. returned: When C(tcp-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex traffic_groups: contains: auto_failback_enabled: description: - Specifies whether the traffic group fails back to the default device. returned: queried sample: true type: bool auto_failback_time: description: - Specifies the time required to fail back. returned: queried sample: 60 type: int description: description: - Description of the traffic group. returned: queried sample: My traffic group type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/tg1 type: str ha_load_factor: description: - Specifies a number for this traffic group that represents the load this traffic group presents to the system relative to other traffic groups. returned: queried sample: 1 type: int ha_order: description: - This list of devices specifies the order in which the devices will become active for the traffic group when a failure occurs. returned: queried sample: - /Common/device1 - /Common/device2 type: list is_floating: description: - Indicates whether the traffic group can fail over to other devices in the device group. returned: queried sample: false type: bool mac_masquerade_address: description: - Specifies a MAC address for the traffic group. returned: queried sample: 00:98:76:54:32:10 type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: tg1 type: str description: Traffic group related information. returned: When C(traffic-groups) is specified in C(gather_subset). sample: hash/dictionary of values type: complex trunks: contains: configured_member_count: description: - The number of configured members that are associated with the trunk. returned: queried sample: 1 type: int description: description: - Description of the Trunk. returned: queried sample: My trunk type: str distribution_hash: description: - 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. returned: queried sample: src-dst-ipport type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/trunk1 type: str interfaces: description: - The list of interfaces that are part of the trunk. returned: queried sample: - '1.2' - '1.3' type: list lacp_enabled: description: - Whether LACP is enabled or not. returned: queried sample: true type: bool lacp_mode: description: - The operation mode for LACP. returned: queried sample: passive type: str lacp_timeout: description: - The rate at which the system sends the LACP control packets. returned: queried sample: 10 type: int link_selection_policy: description: - The LACP policy the trunk uses to determine which member link can handle new traffic. returned: queried sample: maximum-bandwidth type: str media_speed: description: - Speed of the media attached to the trunk. returned: queried sample: 10000 type: int media_status: description: - Whether the media that is part of the trunk is up or not. returned: queried sample: true type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: trunk1 type: str operational_member_count: description: - Number of working members associated with the trunk. returned: queried sample: 1 type: int stp_enabled: description: - Whether Spanning Tree Protocol (STP) is enabled or not. returned: queried sample: true type: bool description: Trunk related information. returned: When C(trunks) is specified in C(gather_subset). sample: hash/dictionary of values type: complex ucs: contains: encrypted: description: - Whether the file is encrypted or not. returned: queried sample: false type: bool file_created_date: description: - Date and time when the ucs file was created. returned: queried sample: '2022-03-10T09:30:19Z' type: str file_name: description: - Name of the UCS backup file. returned: queried sample: backup.ucs type: str file_size: description: - Size of the UCS file in bytes. returned: queried sample: '3' type: str description: UCS backup related information returned: When C(ucs) is specified in C(gather_subset) sample: hash/dictionary of values type: complex version_added: 1.15.0 version_added_collection: f5networks.f5_modules udp_profiles: contains: allow_no_payload: description: - Allow the passage of datagrams that contain header information, but no essential data. returned: queried sample: true type: bool buffer_max_bytes: description: - Ingress buffer byte limit. Maximum allowed value is 16777215. returned: queried sample: 655350 type: int buffer_max_packets: description: - Ingress buffer packet limit. Maximum allowed value is 255. returned: queried sample: 0 type: int datagram_load_balancing: description: - Load balance UDP datagram by datagram returned: queried sample: true type: bool description: description: - Description of the resource. returned: queried sample: My profile type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: udp type: str idle_timeout: description: - 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 C(indefinite) or C(immediate). returned: queried sample: 200 type: bool ip_df_mode: description: - Describes the Don't Fragment (DF) bit setting in the outgoing UDP packet. - May be one of C(pmtu), C(preserve), C(set), or C(clear). - When C(pmtu), sets the outgoing UDP packet DF big based on the ip pmtu setting. - When C(preserve), preserves the incoming UDP packet Don't Fragment bit. - When C(set), sets the outgoing UDP packet DF bit. - When C(clear), clears the outgoing UDP packet DF bit. returned: queried sample: pmtu type: str ip_tos_to_client: description: - The Type of Service level the traffic management system assigns to UDP packets when sending them to clients. - May be numeric, or the values C(pass-through) or C(mimic). returned: queried sample: mimic type: str ip_ttl_mode: description: - The outgoing UDP packet's TTL mode. - Valid modes are C(proxy), C(preserve), C(decrement), and C(set). - When C(proxy), sets the IP TTL of IPv4 to the default value of 255 and IPv6 to the default value of 64. - When C(preserve), sets the IP TTL to the original packet TTL value. - When C(decrement), sets the IP TTL to the original packet TTL value minus 1. - When C(set), sets the IP TTL with the specified values in C(ip_ttl_v4) and C(ip_ttl_v6) values in the same profile. returned: queried sample: proxy type: str ip_ttl_v4: description: - IPv4 TTL. returned: queried sample: 10 type: int ip_ttl_v6: description: - IPv6 TTL. returned: queried sample: 100 type: int link_qos_to_client: description: - The Quality of Service level the system assigns to UDP packets when sending them to clients. - May be either numberic or the value C(pass-through). returned: queried sample: pass-through type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: /Common/udp type: str no_checksum: description: - Whether checksum processing is enabled or disabled. - Note that if the datagram is IPv6, the system always performs checksum processing. returned: queried sample: true type: bool parent: description: - Profile from which this profile inherits settings. returned: queried sample: udp type: str proxy_mss: description: - When C(true), specifies the system advertises the same mss to the server as was negotiated with the client. returned: queried sample: true type: bool description: UDP profile related information. returned: When C(udp-profiles) is specified in C(gather_subset). sample: hash/dictionary of values type: complex users: contains: description: description: - Description of the resource. returned: queried sample: Admin user type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: admin type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: admin type: str partition_access: contains: name: description: - Name of partition. returned: queried sample: all-partitions type: str role: description: - Role allowed to user on partition. returned: queried sample: auditor type: str description: - Partition that user has access to, including user role. returned: queried type: complex shell: description: - The shell assigned to the user account. returned: queried sample: tmsh type: str description: Details of the users on the system. returned: When C(users) is specified in C(gather_subset). type: complex vcmp_guests: contains: allowed_slots: description: - List of slots the guest is allowed to be assigned to. returned: queried sample: - 0 - 1 - 3 type: list assigned_slots: description: - Slots the guest is assigned to. returned: queried sample: - 0 type: list boot_priority: description: - Specifies the boot priority of the guest. A lower number means earlier to boot. returned: queried sample: 65535 type: int cores_per_slot: description: - Number of cores the system allocates to the guest. returned: queried sample: 2 type: int full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: guest1 type: str hostname: description: - FQDN assigned to the guest. returned: queried sample: guest1.localdomain type: str hotfix_image: description: - Hotfix image to install onto any of this guest's newly created virtual disks. returned: queried sample: Hotfix-BIGIP-12.1.3.4-0.0.2-hf1.iso type: str initial_image: description: - Software image to install onto any of this guest's newly created virtual disks. returned: queried sample: BIGIP-12.1.3.4-0.0.2.iso type: str mgmt_address: description: - Management IP address configuration for the guest. returned: queried sample: 2.3.2.3 type: str mgmt_network: description: - Accessibility of this vCMP guest's management network. returned: queried sample: bridged type: str mgmt_route: description: - Management gateway IP address for the guest. returned: queried sample: 2.2.2.1 type: str min_number_of_slots: description: - Specifies the minimum number of slots the guest must be assigned to. returned: queried sample: 2 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: guest1 type: str number_of_slots: description: - Specifies the number of slots the guest should be assigned to. - This number is always greater than, or equal to, C(min_number_of_slots). returned: queried sample: 2 type: int ssl_mode: description: - The SSL hardware allocation mode for the guest. returned: queried sample: shared type: str state: description: - Specifies the state of the guest. - May be one of C(configured), C(provisioned), or C(deployed). - Each state implies the actions of all states before it. returned: queried sample: provisioned type: str virtual_disk: description: - The filename of the virtual disk to use for this guest. returned: queried sample: guest1.img type: str vlans: description: - List of VLANs on which the guest is either enabled or disabled. returned: queried sample: - /Common/vlan1 - /Common/vlan2 type: list description: vCMP related information. returned: When C(vcmp-guests) is specified in C(gather_subset). sample: hash/dictionary of values type: complex virtual_addresses: contains: address: description: - The virtual IP address. returned: queried sample: 2.3.4.5 type: str arp_enabled: description: - Whether or not ARP is enabled for the specified virtual address. returned: queried sample: true type: bool auto_delete_enabled: description: - Indicates if the virtual address will be deleted automatically on deletion of the last associated virtual server or not. returned: queried sample: false type: bool connection_limit: description: - Concurrent connection limit for one or more virtual servers. returned: queried sample: 0 type: int description: description: - The description of the virtual address. returned: queried sample: My virtual address type: str enabled: description: - Whether the virtual address is enabled or not. returned: queried sample: true type: bool floating: description: - 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. returned: queried sample: true type: bool full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/2.3.4.5 type: str icmp_echo: description: - Whether the virtual address should reply to ICMP echo requests. returned: queried sample: true type: bool inherited_traffic_group: description: - Indicates if the traffic group is inherited from the parent folder. returned: queried sample: false type: bool name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: 2.3.4.5 type: str netmask: description: - Netmask of the virtual address. returned: queried sample: 255.255.255.255 type: str route_advertisement: description: - Specifies the route advertisement setting for the virtual address. returned: queried sample: false type: bool spanning: description: - Whether or not spanning is enabled for the specified virtual address. returned: queried sample: false type: bool traffic_group: description: - Traffic group on which the virtual address is active. returned: queried sample: /Common/traffic-group-1 type: str description: Virtual address related information. returned: When C(virtual-addresses) is specified in C(gather_subset). sample: hash/dictionary of values type: complex virtual_servers: contains: authentication_profile: description: - Specifies a list of authentication profile names, separated by spaces, that the virtual server uses to manage authentication. returned: queried sample: - /Common/ssl_drldp type: list auto_lasthop: description: - 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. returned: queried sample: default type: str availability_status: description: - The availability of the virtual server. returned: queried sample: offline type: str bw_controller_policy: description: - The bandwidth controller for the system to use to enforce a throughput policy for incoming network traffic. returned: queried sample: /Common/bw1 type: str client_side_bits_in: description: - Number of client-side ingress bits. returned: queried sample: 1000 type: int client_side_bits_out: description: - Number of client-side egress bits. returned: queried sample: 200 type: int client_side_current_connections: description: - Number of current connections client-side. returned: queried sample: 300 type: int client_side_evicted_connections: description: - Number of evicted connections client-side. returned: queried sample: 100 type: int client_side_max_connections: description: - Maximum number of connections client-side. returned: queried sample: 40 type: int client_side_pkts_in: description: - Number of client-side ingress packets. returned: queried sample: 1098384 type: int client_side_pkts_out: description: - Number of client-side egress packets. returned: queried sample: 3484734 type: int client_side_slow_killed: description: - Number of slow connections killed, client-side. returned: queried sample: 234 type: int client_side_total_connections: description: - Total number of connections. returned: queried sample: 24 type: int cmp_enabled: description: - Whether or not clustered multi-processor (CMP) acceleration is enabled. returned: queried sample: true type: bool cmp_mode: description: - The clustered-multiprocessing mode. returned: queried sample: all-cpus type: str connection_limit: description: - Maximum number of concurrent connections you want to allow for the virtual server. returned: queried sample: 100 type: int connection_mirror_enabled: description: - Whether or not connection mirroring is enabled. returned: queried sample: true type: bool cpu_usage_ratio_last_1_min: description: - CPU Usage Ratio (%) Last 1 Minute. returned: queried sample: 0 type: int cpu_usage_ratio_last_5_min: description: - CPU Usage Ratio (%) Last 5 Minutes. returned: queried sample: 0 type: int cpu_usage_ratio_last_5_sec: description: - CPU Usage Ratio (%) Last 5 Seconds. returned: queried sample: 0 type: int current_syn_cache: description: - Current SYN Cache. returned: queried sample: 0 type: int default_pool: description: - Pool name you want the virtual server to use as the default pool. returned: queried sample: /Common/pool1 type: str description: description: - The description of the virtual server. returned: queried sample: My virtual type: str destination: description: - Name of the virtual address and service on which the virtual server listens for connections. returned: queried sample: /Common/2.2.3.3%1:76 type: str destination_address: description: - Address portion of the C(destination). returned: queried sample: 2.3.3.2 type: str destination_port: description: - Port potion of the C(destination). returned: queried sample: 80 type: int enabled: description: - Whether or not the virtual is enabled. returned: queried sample: true type: bool ephemeral_bits_in: description: - Number of ephemeral ingress bits. returned: queried sample: 1000 type: int ephemeral_bits_out: description: - Number of ephemeral egress bits. returned: queried sample: 200 type: int ephemeral_current_connections: description: - Number of ephemeral current connections. returned: queried sample: 300 type: int ephemeral_evicted_connections: description: - Number of ephemeral evicted connections. returned: queried sample: 100 type: int ephemeral_max_connections: description: - Maximum number of ephemeral connections. returned: queried sample: 40 type: int ephemeral_pkts_in: description: - Number of ephemeral ingress packets. returned: queried sample: 1098384 type: int ephemeral_pkts_out: description: - Number of ephemeral egress packets. returned: queried sample: 3484734 type: int ephemeral_slow_killed: description: - Number of ephemeral slow connections killed. returned: queried sample: 234 type: int ephemeral_total_connections: description: - Total number of ephemeral connections. returned: queried sample: 24 type: int fallback_persistence_profile: description: - Fallback persistence profile for the virtual server to use when the default persistence profile is not available. returned: queried sample: /Common/fallback1 type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/2.3.4.5 type: str gtm_score: description: - Specifies a score that is associated with the virtual server. returned: queried sample: 0 type: int hardware_syn_cookie_instances: description: - Hardware SYN Cookie Instances. returned: queried sample: 0 type: int ip_intelligence_policy: description: - IP Intelligence policy assigned to the virtual. returned: queried sample: /Common/ip1 type: str irules: description: - List of iRules that customize the virtual server to direct and manage traffic. returned: queried sample: - /Common/rule1 - /Common/rule2' type: list last_hop_pool: description: - Name of the last hop pool you want the virtual server to use to direct reply traffic to the last hop router. returned: queried sample: /Common/pool1 type: str max_conn_duration: description: - Max Conn Duration/msec. returned: queried sample: 0 type: int mean_conn_duration: description: - Mean Conn Duration/msec. returned: queried sample: 0 type: int min_conn_duration: description: - Min Conn Duration/msec. returned: queried sample: 0 type: int name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: 2.3.4.5 type: str nat64_enabled: description: - Whether or not NAT64 is enabled. returned: queried sample: true type: bool persistence_profile: description: - The persistence profile you want the system to use as the default for this virtual server. returned: queried sample: /Common/persist1 type: str policies: description: - List of LTM policies attached to the virtual server. returned: queried sample: - /Common/policy1 - /Common/policy2' type: list profiles: contains: context: description: - Which side of the connection the profile affects; either C(all), C(client-side) or C(server-side). returned: queried sample: client-side type: str full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: /Common/tcp type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: tcp type: str description: - List of the profiles attached to the virtual. type: complex protocol: description: - IP protocol for which you want the virtual server to direct traffic. returned: queried sample: tcp type: str rate_class: description: - Name of an existing rate class you want the virtual server to use to enforce a throughput policy for incoming network traffic. returned: queried type: str rate_limit: description: - Maximum number of connections per second allowed for a virtual server. returned: queried sample: 34 type: int rate_limit_destination_mask: description: - Specifies a mask, in bits, to be applied to the destination address as part of the rate limiting. returned: queried sample: 32 type: int rate_limit_mode: description: - Indicates whether the rate limit is applied per virtual object, per source address, per destination address, or some combination thereof. returned: queried sample: object type: str rate_limit_source_mask: description: - Specifies a mask, in bits, to be applied to the source address as part of the rate limiting. returned: queried sample: 0 type: int security_log_profiles: description: - Specifies the log profile applied to the virtual server. returned: queried sample: - /Common/global-network - /Common/local-dos type: list snat_pool: description: - Specifies the name of a LSN or SNAT pool used by the specified virtual server. returned: queried sample: /Common/pool1 type: str snat_type: description: - Specifies the type of source address translation associated with the specified virtual server. returned: queried sample: none type: str software_syn_cookie_instances: description: - Software SYN Cookie Instances. returned: queried sample: 0 type: int source_address: description: - Specifies an IP address or network from which the virtual server will accept traffic. returned: queried sample: 0.0.0./0 type: str source_port_behavior: description: - Specifies whether the system preserves the source port of the connection. returned: queried sample: preserve type: str status_reason: description: - If there is a problem with the status of the virtual, it is reported here. returned: queried sample: The children pool member(s) either don't have service checking... type: str syn_cache_overflow: description: - SYN Cache Overflow. returned: queried sample: 0 type: int syn_cookies_status: description: - SYN Cookies Status. returned: queried sample: not-activated type: str total_hardware_accepted_syn_cookies: description: - SYN Cookies Total Hardware Accepted. returned: queried sample: 0 type: int total_hardware_syn_cookies: description: - SYN Cookies Total Hardware. returned: queried sample: 0 type: int total_requests: description: - Total requests. returned: queried sample: 8 type: int total_software_accepted_syn_cookies: description: - SYN Cookies Total Software Accepted. returned: queried sample: 0 type: int total_software_rejected_syn_cookies: description: - Total Software Rejected. returned: queried sample: 0 type: int total_software_syn_cookies: description: - Total Software SYN Cookies returned: queried sample: 0 type: int translate_address: description: - Enables or disables address translation for the virtual server. returned: queried sample: true type: bool translate_port: description: - Enables or disables port translation. returned: queried sample: true type: bool type: description: - Virtual server type. returned: queried sample: standard type: str vlans: description: - List of VLANs on which the virtual server is either enabled or disabled. returned: queried sample: - /Common/vlan1 - /Common/vlan2 type: list description: Virtual address related information. returned: When C(virtual-addresses) is specified in C(gather_subset). sample: hash/dictionary of values type: complex vlans: contains: auto_lasthop: description: - 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. returned: queried sample: enabled type: str cmp_hash_algorithm: description: - Specifies how the traffic on the VLAN will be disaggregated. returned: queried sample: default type: str description: description: - Description of the VLAN. returned: queried sample: My vlan type: str failsafe_action: description: - Action for the system to take when the fail-safe mechanism is triggered. returned: queried sample: reboot type: str failsafe_enabled: description: - Whether failsafe is enabled or not. returned: queried sample: true type: bool failsafe_timeout: description: - Number of seconds that an active unit can run without detecting network traffic on this VLAN before it starts a failover. returned: queried sample: 90 type: int if_index: description: - Index assigned to this VLAN. It is a unique identifier assigned for all objects displayed in the SNMP IF-MIB. returned: queried sample: 176 type: int interfaces: contains: full_path: description: - Full name of the resource as known to the BIG-IP. returned: queried sample: 1.3 type: str name: description: - Relative name of the resource in the BIG-IP. returned: queried sample: 1.3 type: str tagged: description: - Whether the interface is tagged or not. returned: queried sample: false type: bool description: - List of tagged or untagged interfaces and trunks that you want to configure for the VLAN. returned: queried type: complex learning_mode: description: - Whether switch ports placed in the VLAN are configured for switch learning, forwarding only, or dropped. returned: queried sample: enable-forward type: str mtu: description: - Specific maximum transition unit (MTU) for the VLAN. returned: queried sample: 1500 type: int sflow_poll_interval: description: - Maximum interval in seconds between two pollings. returned: queried sample: 0 type: int sflow_poll_interval_global: description: - Whether the global VLAN poll-interval setting overrides the object-level poll-interval setting. returned: queried sample: false type: bool sflow_sampling_rate: description: - Ratio of packets observed to the samples generated. returned: queried sample: 0 type: int sflow_sampling_rate_global: description: - Whether the global VLAN sampling-rate setting overrides the object-level sampling-rate setting. returned: queried sample: true type: bool source_check_enabled: description: - Specifies that only connections that have a return route in the routing table are accepted. returned: queried sample: true type: bool tag: description: - Tag number for the VLAN. returned: queried sample: 30 type: int true_mac_address: description: - Media access control (MAC) address for the lowest-numbered interface assigned to this VLAN. returned: queried sample: fa:16:3e:10:da:ff type: str description: List of VLAN information. returned: When C(vlans) is specified in C(gather_subset). sample: hash/dictionary of values type: complex