F5 BIG-IP LTM

Publisher: Splunk
Connector Version: 2.1.1
Product Vendor: F5
Product Name: Local Traffic Manager
Product Version Supported (regex): ".*"
Minimum Product Version: 5.1.0

This app implements investigate and generic actions to integrate with an F5 BIG-IP LTM instance to manage pools and nodes

Configuration Variables

The below configuration variables are required for this Connector to operate. These variables are specified when configuring a Local Traffic Manager asset in SOAR.

VARIABLE	REQUIRED	TYPE	DESCRIPTION
base_url	required	string	Base URL of F5 BIG-IP LTM instance (e.g. https://10.1.16.110)
username	required	string	User name
password	required	password	Password
verify_server_cert	optional	boolean	Verify Server SSL certificate

Supported Actions

test connectivity - Validate the asset configuration for connectivity using the supplied configuration
create node - Create a new node
delete node - Delete a node
remove node - Remove a node from a pool
create pool - Create a new pool
delete pool - Delete an existing pool
add node - Add an existing node to a pool
disable node - Disable a node
enable node - Enable a node
describe node - Get information about a node
get node stats - Get stats of the node
list nodes - Fetch a list of nodes (if no value is provided, all nodes will be returned)
list pools - Fetch a list of configured pools (if no value is provided, all pools will be returned)
list members - Fetch a list of configured node members of a pool (if no value is provided, all node members of a pool will be returned)

action: 'test connectivity'

Validate the asset configuration for connectivity using the supplied configuration

Type: test
Read only: True

Action Parameters

No parameters are required for this action

Action Output

No Output

action: 'create node'

Create a new node

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node to create	string	`f5 node name`
partition_name	required	Name of the partition	string	`f5 partition name`
ip_address	required	IP address of the new node	string	`ip` `ipv6`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.ip_address	string	`ip` `ipv6`
action_result.parameter.node_name	string	`f5 node name`
action_result.parameter.partition_name	string	`f5 partition name`
action_result.data.*.address	string	`ip`
action_result.data.*.connectionLimit	numeric
action_result.data.*.dynamicRatio	numeric
action_result.data.*.ephemeral	string
action_result.data.*.fqdn.addressFamily	string
action_result.data.*.fqdn.autopopulate	string
action_result.data.*.fqdn.downInterval	numeric
action_result.data.*.fqdn.interval	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.kind	string
action_result.data.*.logging	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 node name`
action_result.data.*.partition	string	`f5 partition name`
action_result.data.*.rateLimit	string
action_result.data.*.ratio	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.session	string
action_result.data.*.state	string
action_result.summary.node_name	string	`f5 node name`
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'delete node'

Delete a node

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node to delete	string	`f5 node name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.node_name	string	`f5 node name`
action_result.data	string
action_result.summary.node_name	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'remove node'

Remove a node from a pool

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node to remove	string	`f5 node name`
port	required	Port number	string	`port`
pool_name	required	Name of the pool to remove the node from	string	`f5 pool name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.node_name	string	`f5 node name`
action_result.parameter.pool_name	string	`f5 pool name`
action_result.parameter.port	string	`port`
action_result.data	string
action_result.summary.node_name	string	`f5 node name`
action_result.summary.pool_name	string	`f5 pool name`
action_result.summary.port	string	`port`
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'create pool'

Create a new pool

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
pool_name	required	Name of the pool to create	string	`f5 pool name`
pool_description	optional	Description of the pool	string
partition_name	required	Name of the partition	string	`f5 partition name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.partition_name	string	`f5 partition name`
action_result.parameter.pool_description	string
action_result.parameter.pool_name	string	`f5 pool name`
action_result.data.*.allowNat	string
action_result.data.*.allowSnat	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.ignorePersistedWeight	string
action_result.data.*.ipTosToClient	string
action_result.data.*.ipTosToServer	string
action_result.data.*.kind	string
action_result.data.*.linkQosToClient	string
action_result.data.*.linkQosToServer	string
action_result.data.*.loadBalancingMode	string
action_result.data.*.membersReference.isSubcollection	boolean
action_result.data.*.membersReference.link	string	`url`
action_result.data.*.minActiveMembers	numeric
action_result.data.*.minUpMembers	numeric
action_result.data.*.minUpMembersAction	string
action_result.data.*.minUpMembersChecking	string
action_result.data.*.name	string	`f5 pool name`
action_result.data.*.partition	string	`f5 partition name`
action_result.data.*.queueDepthLimit	numeric
action_result.data.*.queueOnConnectionLimit	string
action_result.data.*.queueTimeLimit	numeric
action_result.data.*.reselectTries	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.serviceDownAction	string
action_result.data.*.slowRampTime	numeric
action_result.summary.partition	string	`f5 partition name`
action_result.summary.pool_description	string
action_result.summary.pool_name	string	`f5 pool name`
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'delete pool'

Delete an existing pool

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
pool_name	required	Name of the pool to delete	string	`f5 pool name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.pool_name	string	`f5 pool name`
action_result.data	string
action_result.summary.pool_name	string	`f5 pool name`
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'add node'

Add an existing node to a pool

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node to add	string	`f5 node name`
partition_name	required	Name of the partition to add node	string	`f5 partition name`
port	required	Port number	string	`port`
pool_name	required	Name of the pool to add node member	string	`f5 pool name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.node_name	string	`f5 node name`
action_result.parameter.partition_name	string	`f5 partition name`
action_result.parameter.pool_name	string	`f5 pool name`
action_result.parameter.port	string	`port`
action_result.data.*.address	string	`ip`
action_result.data.*.connectionLimit	numeric
action_result.data.*.dynamicRatio	numeric
action_result.data.*.ephemeral	string
action_result.data.*.fqdn.autopopulate	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.inheritProfile	string
action_result.data.*.kind	string
action_result.data.*.logging	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 node name`
action_result.data.*.partition	string	`f5 partition name`
action_result.data.*.priorityGroup	numeric
action_result.data.*.rateLimit	string
action_result.data.*.ratio	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.session	string
action_result.data.*.state	string
action_result.summary.node_name	string
action_result.summary.pool_name	string	`f5 pool name`
action_result.summary.port	string	`port`
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'disable node'

Disable a node

Type: contain
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node to disable	string	`f5 node name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.node_name	string	`f5 node name`
action_result.data.*.address	string	`ip`
action_result.data.*.connectionLimit	numeric
action_result.data.*.description	string
action_result.data.*.dynamicRatio	numeric
action_result.data.*.ephemeral	string
action_result.data.*.fqdn.addressFamily	string
action_result.data.*.fqdn.autopopulate	string
action_result.data.*.fqdn.downInterval	numeric
action_result.data.*.fqdn.interval	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.kind	string
action_result.data.*.logging	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 node name`
action_result.data.*.rateLimit	string
action_result.data.*.ratio	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.session	string
action_result.data.*.state	string
action_result.summary.node_name	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'enable node'

Enable a node

Type: correct
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node to enable	string	`f5 node name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.node_name	string	`f5 node name`
action_result.data.*.address	string	`ip`
action_result.data.*.connectionLimit	numeric
action_result.data.*.description	string
action_result.data.*.dynamicRatio	numeric
action_result.data.*.ephemeral	string
action_result.data.*.fqdn.addressFamily	string
action_result.data.*.fqdn.autopopulate	string
action_result.data.*.fqdn.downInterval	numeric
action_result.data.*.fqdn.interval	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.kind	string
action_result.data.*.logging	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 node name`
action_result.data.*.rateLimit	string
action_result.data.*.ratio	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.session	string
action_result.data.*.state	string
action_result.summary.node_name	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'describe node'

Get information about a node

Type: investigate
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node to describe	string	`f5 node name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.node_name	string	`f5 node name`
action_result.data.*.address	string	`ip`
action_result.data.*.connectionLimit	numeric
action_result.data.*.dynamicRatio	numeric
action_result.data.*.ephemeral	string
action_result.data.*.fqdn.addressFamily	string
action_result.data.*.fqdn.autopopulate	string
action_result.data.*.fqdn.downInterval	numeric
action_result.data.*.fqdn.interval	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.kind	string
action_result.data.*.logging	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 node name`
action_result.data.*.rateLimit	string
action_result.data.*.ratio	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.session	string
action_result.data.*.state	string
action_result.summary.state	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'get node stats'

Get stats of the node

Type: investigate
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
node_name	required	Name of the node	string	`f5 node name`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.node_name	string	`f5 node name`
action_result.data.*.addr.description	string
action_result.data.*.curSessions.value	numeric
action_result.data.*.monitorRule.description	string
action_result.data.*.monitorStatus.description	string
action_result.data.*.serverside_bitsIn.value	numeric
action_result.data.*.serverside_bitsOut.value	numeric
action_result.data.*.serverside_curConns.value	numeric
action_result.data.*.serverside_maxConns.value	numeric
action_result.data.*.serverside_pktsIn.value	numeric
action_result.data.*.serverside_pktsOut.value	numeric
action_result.data.*.serverside_totConns.value	numeric
action_result.data.*.sessionStatus.description	string
action_result.data.*.status_availabilityState.description	string
action_result.data.*.status_enabledState.description	string
action_result.data.*.status_statusReason.description	string
action_result.data.*.tmName.description	string
action_result.data.*.totRequests.value	numeric
action_result.summary.num_connections	numeric
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'list nodes'

Fetch a list of nodes (if no value is provided, all nodes will be returned)

Type: investigate
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
max_results	optional	Max number of nodes to return	numeric

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.max_results	numeric
action_result.data.*.address	string	`ip`
action_result.data.*.connectionLimit	numeric
action_result.data.*.description	string
action_result.data.*.dynamicRatio	numeric
action_result.data.*.ephemeral	string
action_result.data.*.fqdn.addressFamily	string
action_result.data.*.fqdn.autopopulate	string
action_result.data.*.fqdn.downInterval	numeric
action_result.data.*.fqdn.interval	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.kind	string
action_result.data.*.logging	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 node name`
action_result.data.*.partition	string	`f5 partition name`
action_result.data.*.rateLimit	string
action_result.data.*.ratio	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.session	string
action_result.data.*.state	string
action_result.summary.node_names	string
action_result.summary.num_nodes	numeric
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'list pools'

Fetch a list of configured pools (if no value is provided, all pools will be returned)

Type: investigate
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
max_results	optional	Max number of pools to return	numeric

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.max_results	numeric
action_result.data.*.allowNat	string
action_result.data.*.allowSnat	string
action_result.data.*.description	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.ignorePersistedWeight	string
action_result.data.*.ipTosToClient	string
action_result.data.*.ipTosToServer	string
action_result.data..items..addressStatus	string
action_result.data..items..autoLasthop	string
action_result.data..items..cmpEnabled	string
action_result.data..items..connectionLimit	numeric
action_result.data..items..creationTime	string
action_result.data..items..destination	string
action_result.data..items..enabled	boolean
action_result.data..items..evictionProtected	string
action_result.data..items..fullPath	string
action_result.data..items..generation	numeric
action_result.data..items..gtmScore	numeric
action_result.data..items..ipProtocol	string
action_result.data..items..kind	string
action_result.data..items..lastModifiedTime	string
action_result.data..items..mask	string	`ip`
action_result.data..items..mirror	string
action_result.data..items..mobileAppTunnel	string
action_result.data..items..name	string
action_result.data..items..nat64	string
action_result.data..items..partition	string	`f5 partition name`
action_result.data..items..policiesReference.isSubcollection	boolean
action_result.data..items..policiesReference.link	string	`url`
action_result.data..items..pool	string
action_result.data..items..poolReference.link	string	`url`
action_result.data..items..profilesReference.isSubcollection	boolean
action_result.data..items..profilesReference.link	string	`url`
action_result.data..items..rateLimit	string
action_result.data..items..rateLimitDstMask	numeric
action_result.data..items..rateLimitMode	string
action_result.data..items..rateLimitSrcMask	numeric
action_result.data..items..selfLink	string	`url`
action_result.data..items..serviceDownImmediateAction	string
action_result.data..items..source	string
action_result.data..items..sourceAddressTranslation.type	string
action_result.data..items..sourcePort	string
action_result.data..items..synCookieStatus	string
action_result.data..items..translateAddress	string
action_result.data..items..translatePort	string
action_result.data..items..vlansDisabled	boolean
action_result.data..items..vsIndex	numeric
action_result.data.*.kind	string
action_result.data.*.linkQosToClient	string
action_result.data.*.linkQosToServer	string
action_result.data.*.loadBalancingMode	string
action_result.data.*.membersReference.isSubcollection	boolean
action_result.data.*.membersReference.link	string	`url`
action_result.data.*.minActiveMembers	numeric
action_result.data.*.minUpMembers	numeric
action_result.data.*.minUpMembersAction	string
action_result.data.*.minUpMembersChecking	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 pool name`
action_result.data.*.partition	string	`f5 partition name`
action_result.data.*.queueDepthLimit	numeric
action_result.data.*.queueOnConnectionLimit	string
action_result.data.*.queueTimeLimit	numeric
action_result.data.*.reselectTries	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.serviceDownAction	string
action_result.data.*.slowRampTime	numeric
action_result.summary.num_pools	numeric
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'list members'

Fetch a list of configured node members of a pool (if no value is provided, all node members of a pool will be returned)

Type: investigate
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
pool_name	required	Name of the pool	string	`f5 pool name`
partition_name	required	Name of the partition	string	`f5 partition name`
max_results	optional	Max number of members to return	numeric

Action Output

DATA PATH	TYPE	CONTAINS
action_result.status	string
action_result.parameter.max_results	numeric
action_result.parameter.partition_name	string	`f5 partition name`
action_result.parameter.pool_name	string	`f5 pool name`
action_result.data.*.address	string	`ip`
action_result.data.*.connectionLimit	numeric
action_result.data.*.dynamicRatio	numeric
action_result.data.*.ephemeral	string
action_result.data.*.fqdn.autopopulate	string
action_result.data.*.fullPath	string
action_result.data.*.generation	numeric
action_result.data.*.inheritProfile	string
action_result.data.*.kind	string
action_result.data.*.logging	string
action_result.data.*.monitor	string
action_result.data.*.name	string	`f5 node name`
action_result.data.*.partition	string	`f5 partition name`
action_result.data.*.priorityGroup	numeric
action_result.data.*.rateLimit	string
action_result.data.*.ratio	numeric
action_result.data.*.selfLink	string	`url`
action_result.data.*.session	string
action_result.data.*.state	string
action_result.summary.members	string
action_result.summary.num_members	numeric
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

Name		Name	Last commit message	Last commit date
Latest commit History 112 Commits
.github/workflows		.github/workflows
release_notes		release_notes
wheels		wheels
.pre-commit-config.yaml		.pre-commit-config.yaml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
NOTICE		NOTICE
README.md		README.md
__init__.py		__init__.py
exclude_files.txt		exclude_files.txt
f5bigipltm.json		f5bigipltm.json
f5bigipltm_connector.py		f5bigipltm_connector.py
logo_f5bigipltm.svg		logo_f5bigipltm.svg
logo_f5bigipltm_dark.svg		logo_f5bigipltm_dark.svg
renovate.json		renovate.json
requirements.txt		requirements.txt
tox.ini		tox.ini

License

sodle-splunk/f5bigipltm-renovatebot-poc

Folders and files

Latest commit

History

Repository files navigation

F5 BIG-IP LTM

Configuration Variables

Supported Actions

action: 'test connectivity'

Action Parameters

Action Output

action: 'create node'

Action Parameters

Action Output

action: 'delete node'

Action Parameters

Action Output

action: 'remove node'

Action Parameters

Action Output

action: 'create pool'

Action Parameters

Action Output

action: 'delete pool'

Action Parameters

Action Output

action: 'add node'

Action Parameters

Action Output

action: 'disable node'

Action Parameters

Action Output

action: 'enable node'

Action Parameters

Action Output

action: 'describe node'

Action Parameters

Action Output

action: 'get node stats'

Action Parameters

Action Output

action: 'list nodes'

Action Parameters

Action Output

action: 'list pools'

Action Parameters

Action Output

action: 'list members'

Action Parameters

Action Output

About

Resources

License

Stars

Watchers

Forks

Languages