F5 LTM
This Integration is part of the F5 LTM Pack.#
Supported versions
Available on Cortex XSOAR (versions 6.0.0 and later) and Cortex XSIAM.
Manages F5 LTM This integration was integrated and tested with version 16.1.0 of F5LTM
Configure F5 LTM in Cortex#
| Parameter | Description | Required |
|---|---|---|
| Server Address | True | |
| Port Number | True | |
| The administrative partition | False | |
| Username | The Username to use for connection | True |
| Password | True | |
| Trust any certificate (not secure) | Trust any certificate (not secure). | False |
| Use system proxy settings | Use system proxy settings. | False |
Commands#
You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
f5-ltm-get-pools#
Get a list of all pools
Base Command#
f5-ltm-get-pools
Input#
| Argument Name | Description | Required |
|---|---|---|
| expand | Expand pools in the response. Possible values are: True, False. Default is False. | Optional |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Pools.membersReference.isSubcollection | Boolean | Member reference subcollection retrieved |
| F5.LTM.Pools.membersReference.link | String | Member reference links |
| F5.LTM.Pools.monitor | String | Pool monitor listener |
| F5.LTM.Pools.name | String | Pool names |
| F5.LTM.Pools.partition | String | Configuration partition |
Command Example#
!f5-ltm-get-pools expand="false"
Context Example#
Human Readable Output#
Results#
membersReference monitor name partition link: https://localhost/mgmt/tm/ltm/pool/~Common~Temp/members?ver=16.1.0
isSubcollection: true/Common/https_443 Temp Common link: https://localhost/mgmt/tm/ltm/pool/~Common~XSOAR/members?ver=16.1.0
isSubcollection: true/Common/https_443 XSOAR Common
f5-ltm-get-pool#
Get pool details
Base Command#
f5-ltm-get-pool
Input#
| Argument Name | Description | Required |
|---|---|---|
| pool_name | Pool Name. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Pools.allowNat | String | Pool Nat allowed |
| F5.LTM.Pools.allowSnat | String | Pool SNat allowed |
| F5.LTM.Pools.fullPath | String | Pool full path |
| F5.LTM.Pools.generation | Number | Pool generation |
| F5.LTM.Pools.ignorePersistedWeight | String | Ignore Persisted Weight status |
| F5.LTM.Pools.ipTosToClient | String | Client pass through status |
| F5.LTM.Pools.ipTosToServer | String | Server pass through status |
| F5.LTM.Pools.kind | String | Pool kind |
| F5.LTM.Pools.linkQosToClient | String | Link QOS to client status |
| F5.LTM.Pools.linkQosToServer | String | Link QOS to server status |
| F5.LTM.Pools.loadBalancingMode | String | Pool load balancing mode |
| F5.LTM.Pools.membersReference.isSubcollection | Boolean | Members reference subcollection retrieved |
| F5.LTM.Pools.membersReference.link | String | Members reference link |
| F5.LTM.Pools.minActiveMembers | Number | Pool minimum active members |
| F5.LTM.Pools.minUpMembers | Number | Pool minimum Up members |
| F5.LTM.Pools.minUpMembersAction | String | Pool minimum Up members action |
| F5.LTM.Pools.minUpMembersChecking | String | Pool minimum Up members checking |
| F5.LTM.Pools.monitor | String | Pool monitor listener |
| F5.LTM.Pools.name | String | Pool name |
| F5.LTM.Pools.partition | String | Configuration partition |
| F5.LTM.Pools.queueDepthLimit | Number | Pool depth limit |
| F5.LTM.Pools.queueOnConnectionLimit | String | Pool depth queue on connection limit |
| F5.LTM.Pools.queueTimeLimit | Number | Pool queue time limit |
| F5.LTM.Pools.reselectTries | Number | Pool reselect tries |
| F5.LTM.Pools.selfLink | String | Pool self link |
| F5.LTM.Pools.serviceDownAction | String | Pool service down action |
| F5.LTM.Pools.slowRampTime | Number | Pool slow ramp time |
Command Example#
!f5-ltm-get-pool pool_name="XSOAR"
Context Example#
Human Readable Output#
Results#
allowNat allowSnat fullPath generation ignorePersistedWeight ipTosToClient ipTosToServer kind linkQosToClient linkQosToServer loadBalancingMode membersReference minActiveMembers minUpMembers minUpMembersAction minUpMembersChecking monitor name partition queueDepthLimit queueOnConnectionLimit queueTimeLimit reselectTries selfLink serviceDownAction slowRampTime yes yes /Common/XSOAR 1 disabled pass-through pass-through tm:ltm:pool:poolstate pass-through pass-through round-robin link: https://localhost/mgmt/tm/ltm/pool/~Common~XSOAR/members?ver=16.1.0
isSubcollection: true0 0 failover disabled /Common/https_443 XSOAR Common 0 disabled 0 0 https://localhost/mgmt/tm/ltm/pool/~Common~XSOAR?ver=16.1.0 none 10
f5-ltm-get-pool-members#
Get Pool Members
Base Command#
f5-ltm-get-pool-members
Input#
| Argument Name | Description | Required |
|---|---|---|
| pool_name | Pool Name. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Pools.members.address | String | Pool member address |
| F5.LTM.Pools.members.connectionLimit | Number | Pool member connection limit |
| F5.LTM.Pools.members.dynamicRatio | Number | Pool member dynamic ratio |
| F5.LTM.Pools.members.ephemeral | String | Pool member ephemeral |
| F5.LTM.Pools.members.fqdn.autopopulate | String | Pool member fqdn autopopulate |
| F5.LTM.Pools.members.fullPath | String | Pool member full path |
| F5.LTM.Pools.members.generation | Number | Pool member generation |
| F5.LTM.Pools.members.inheritProfile | String | Pool member inherit profile |
| F5.LTM.Pools.members.kind | String | Pool member kind |
| F5.LTM.Pools.members.logging | String | Pool member logging |
| F5.LTM.Pools.members.monitor | String | Pool member monitor |
| F5.LTM.Pools.members.name | String | Pool member name |
| F5.LTM.Pools.members.partition | String | Pool member config partition |
| F5.LTM.Pools.members.priorityGroup | Number | Pool member priority group |
| F5.LTM.Pools.members.rateLimit | String | Pool member rate limit |
| F5.LTM.Pools.members.ratio | Number | Pool member ratio |
| F5.LTM.Pools.members.selfLink | String | Pool member self link |
| F5.LTM.Pools.members.session | String | Pool member session |
| F5.LTM.Pools.members.state | String | Pool member state |
Command Example#
!f5-ltm-get-pool-members pool_name="XSOAR"
Context Example#
Human Readable Output#
Pool Members#
members name XSOAR1:443,
XSOAR2:443XSOAR
f5-ltm-get-nodes#
Get a list of all nodes
Input#
| Argument Name | Description | Required |
|---|---|---|
| partition | The administrative partition. | Optional |
Base Command#
f5-ltm-get-nodes
Input#
There are no input arguments for this command.
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Nodes.address | String | Node address |
| F5.LTM.Nodes.name | String | Node name |
| F5.LTM.Nodes.partition | String | Configuration parition |
| F5.LTM.Nodes.session | String | Node session status |
| F5.LTM.Nodes.state | String | Node checking state |
Command Example#
!f5-ltm-get-nodes
Context Example#
Human Readable Output#
Results#
address name partition session state 2.2.2.2 Test Common user-enabled unchecked 10.10.10.102 XSOAR1 Common user-enabled unchecked 1.1.1.1 XSOAR2 Common user-enabled unchecked
f5-ltm-get-node#
Get node details
Base Command#
f5-ltm-get-node
Input#
| Argument Name | Description | Required |
|---|---|---|
| node_name | Node Name. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Nodes.address | String | Node address |
| F5.LTM.Nodes.connectionLimit | Number | Pool node connection limit |
| F5.LTM.Nodes.dynamicRatio | Number | Pool node dynamic ratio |
| F5.LTM.Nodes.ephemeral | String | Pool node ephemeral |
| F5.LTM.Nodes.fqdn.addressFamily | String | Pool node fqdn address family |
| F5.LTM.Nodes.fqdn.autopopulate | String | Pool node fqdn autopopulate |
| F5.LTM.Nodes.fqdn.downInterval | Number | Pool node fqdn down interval |
| F5.LTM.Nodes.fqdn.interval | String | Pool node fqdn interval |
| F5.LTM.Nodes.fullPath | String | Pool member full path |
| F5.LTM.Nodes.generation | Number | Pool node generation |
| F5.LTM.Nodes.kind | String | Pool node kind |
| F5.LTM.Nodes.logging | String | Pool node logging status |
| F5.LTM.Nodes.monitor | String | Pool node monitor listener |
| F5.LTM.Nodes.name | String | Pool node name |
| F5.LTM.Nodes.partition | String | Pool node configuration partition |
| F5.LTM.Nodes.rateLimit | String | Pool node rate limit |
| F5.LTM.Nodes.ratio | Number | Pool node ratio |
| F5.LTM.Nodes.selfLink | String | Pool node self link |
| F5.LTM.Nodes.session | String | Pool node session status |
| F5.LTM.Nodes.state | String | Pool node checking state |
Command Example#
!f5-ltm-get-node node_name="Test"
Context Example#
Human Readable Output#
Results#
address connectionLimit dynamicRatio ephemeral fqdn fullPath generation kind logging monitor name partition rateLimit ratio selfLink session state 2.2.2.2 0 1 false addressFamily: ipv4
autopopulate: disabled
downInterval: 5
interval: 3600/Common/Test 1 tm:ltm:node:nodestate disabled default Test Common disabled 1 https://localhost/mgmt/tm/ltm/node/~Common~Test?ver=16.1.0 user-enabled unchecked
f5-ltm-disable-node#
Disable a node
Base Command#
f5-ltm-disable-node
Input#
| Argument Name | Description | Required |
|---|---|---|
| node_name | Node to disable. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Nodes.address | String | Node address |
| F5.LTM.Nodes.connectionLimit | Number | Pool node connection limit |
| F5.LTM.Nodes.dynamicRatio | Number | Pool node dynamic ratio |
| F5.LTM.Nodes.ephemeral | String | Pool node ephemeral |
| F5.LTM.Nodes.fqdn.addressFamily | String | Pool node fqdn address family |
| F5.LTM.Nodes.fqdn.autopopulate | String | Pool node fqdn autopopulate |
| F5.LTM.Nodes.fqdn.downInterval | Number | Pool node fqdn down interval |
| F5.LTM.Nodes.fqdn.interval | String | Pool node fqdn interval |
| F5.LTM.Nodes.fullPath | String | Pool member full path |
| F5.LTM.Nodes.generation | Number | Pool node generation |
| F5.LTM.Nodes.kind | String | Pool node kind |
| F5.LTM.Nodes.logging | String | Pool node logging status |
| F5.LTM.Nodes.monitor | String | Pool node monitor listener |
| F5.LTM.Nodes.name | String | Pool node name |
| F5.LTM.Nodes.partition | String | Pool node configuration partition |
| F5.LTM.Nodes.rateLimit | String | Pool node rate limit |
| F5.LTM.Nodes.ratio | Number | Pool node ratio |
| F5.LTM.Nodes.selfLink | String | Pool node self link |
| F5.LTM.Nodes.session | String | Pool node session status |
| F5.LTM.Nodes.state | String | Pool node checking state |
Command Example#
!f5-ltm-disable-node node_name="XSOAR1"
Context Example#
Human Readable Output#
Results#
address connectionLimit dynamicRatio ephemeral fqdn fullPath generation kind logging monitor name partition rateLimit ratio selfLink session state 10.10.10.102 0 1 false addressFamily: ipv4
autopopulate: disabled
downInterval: 5
interval: 3600/Common/XSOAR1 68 tm:ltm:node:nodestate disabled default XSOAR1 Common disabled 1 https://localhost/mgmt/tm/ltm/node/~Common~XSOAR1?ver=16.1.0 user-disabled unchecked
f5-ltm-enable-node#
Enable a node
Base Command#
f5-ltm-enable-node
Input#
| Argument Name | Description | Required |
|---|---|---|
| node_name | Node to enable. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Nodes.address | String | Node address |
| F5.LTM.Nodes.connectionLimit | Number | Pool node connection limit |
| F5.LTM.Nodes.dynamicRatio | Number | Pool node dynamic ratio |
| F5.LTM.Nodes.ephemeral | String | Pool node ephemeral |
| F5.LTM.Nodes.fqdn.addressFamily | String | Pool node fqdn address family |
| F5.LTM.Nodes.fqdn.autopopulate | String | Pool node fqdn autopopulate |
| F5.LTM.Nodes.fqdn.downInterval | Number | Pool node fqdn down interval |
| F5.LTM.Nodes.fqdn.interval | String | Pool node fqdn interval |
| F5.LTM.Nodes.fullPath | String | Pool member full path |
| F5.LTM.Nodes.generation | Number | Pool node generation |
| F5.LTM.Nodes.kind | String | Pool node kind |
| F5.LTM.Nodes.logging | String | Pool node logging status |
| F5.LTM.Nodes.monitor | String | Pool node monitor listener |
| F5.LTM.Nodes.name | String | Pool node name |
| F5.LTM.Nodes.partition | String | Pool node configuration partition |
| F5.LTM.Nodes.rateLimit | String | Pool node rate limit |
| F5.LTM.Nodes.ratio | Number | Pool node ratio |
| F5.LTM.Nodes.selfLink | String | Pool node self link |
| F5.LTM.Nodes.session | String | Pool node session status |
| F5.LTM.Nodes.state | String | Pool node checking state |
Command Example#
!f5-ltm-enable-node node_name="XSOAR1"
Context Example#
Human Readable Output#
Results#
address connectionLimit dynamicRatio ephemeral fqdn fullPath generation kind logging monitor name partition rateLimit ratio selfLink session state 10.10.10.102 0 1 false addressFamily: ipv4
autopopulate: disabled
downInterval: 5
interval: 3600/Common/XSOAR1 67 tm:ltm:node:nodestate disabled default XSOAR1 Common disabled 1 https://localhost/mgmt/tm/ltm/node/~Common~XSOAR1?ver=16.1.0 user-enabled unchecked
f5-ltm-get-pool-member-stats#
Get Pool Member Stats
Base Command#
f5-ltm-get-pool-member-stats
Input#
| Argument Name | Description | Required |
|---|---|---|
| pool_name | Pool to get its stats. | Required |
| member_name | Member to get its stats. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Stats.members.stats.serverside.curConns.value | String | The current connections of the Pool Member |
| F5.LTM.Stats.members.name | String | The pool member name |
| F5.LTM.Stats.members.stats.sessionStatus.description | String | The pool member status |
Command Example#
!f5-ltm-get-pool-member-stats pool_name="XSOAR" member_name="XSOAR1:443"
Context Example#
Human Readable Output#
Pool Member Stats#
curConns member pool 0 XSOAR1:443 XSOAR
f5-ltm-get-node-stats#
Get Node Stats
Base Command#
f5-ltm-get-node-stats
Input#
| Argument Name | Description | Required |
|---|---|---|
| node_name | Node To Query. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Nodes.stats.serverside.curConns.value | String | The current connections of the Node |
| F5.LTM.Nodes.name | String | The node name |
| F5.LTM.Nodes.stats.sessionStatus.description | String | The node status |
Command Example#
!f5-ltm-get-node-stats node_name="XSOAR1"
Context Example#
Human Readable Output#
Node Stats#
curConns node 0 XSOAR1
f5-ltm-get-node-by-address#
Get node information by address
Base Command#
f5-ltm-get-node-by-address
Input#
| Argument Name | Description | Required |
|---|---|---|
| ip_address | IP address of the node. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Nodes.name | String | The node name |
| F5.LTM.Nodes.address | String | The node address |
Command Example#
!f5-ltm-get-node-by-address ip_address="10.10.10.102"
Context Example#
Human Readable Output#
Results#
address name partition session state 10.10.10.102 XSOAR1 Common user-enabled unchecked
f5-ltm-get-pool-by-node#
Get pool information by node
Base Command#
f5-ltm-get-pool-by-node
Input#
| Argument Name | Description | Required |
|---|---|---|
| node_name | Node name. | Required |
| partition | The administrative partition. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| F5.LTM.Nodes.pools | String | The pool names |
| F5.LTM.Nodes.name | String | The node name |
Command Example#
!f5-ltm-get-pool-by-node node_name="XSOAR1"
Context Example#
Human Readable Output#
Results#
name pools XSOAR1 XSOAR