F5 Big IP Tasks

This chapter contains the following sections:

Add Member to F5 Pool

Summary
Add a member to an F5 pool.
Description
This task adds a member to an F5 pool in an F5 Load Balancer.
Inputs
Input Description Mappable To Type Mandatory
Select the Pool name Select the Pool name F5LBPool​Identity
Address Node IP Address Y
Do you want to use existing Node Check this checkbox if you want to add existing node
Node Name Select the node name Y
Service Port Service Port Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​POOL_​IDENTITY F5 Load Balancer Pool Identity.​ F5LBPool​Identity
OUTPUT_​F5_​LB_​POOL_​MEMBER_​IDENTITY F5 Load Balancer Pool Member Identity.​ F5LBPool​Member​Identity

Create F5 Load Balancer Application Service

Summary
Create an F5 Load Balancer application service.
Description
This task creates an iApp Application Service.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Account Select F5 Account F5LBAccount​Identity Y
Select F5 Partition Select F5 Partition F5LBPartition​Identity Y
Application Service name Application Service Name gen_​text_​input Y
Template Application Service Template Name Y
Virtual Server IP Virtual Server IP Address gen_​text_​input Y
Virtual Server Port Virtual Server Port gen_​text_​input Y
FQDN names of Virtual server FQDN names of Virtual server gen_​text_​input Y
Nodes list Add one or more Node detail that can be associated with Virtual Server.​ Y
Inherit Device Group from current Partition/Path Do you want to inherit Device Group from current Partition/Path Y
Device Group Select the Device Group F5LBDevice​Group​Identity Y
Inherit Traffic Group from current Partition/Path Do you want to inherit Traffic Group from current Partition/Path Y
Traffic Group Select the Traffic Group F5LBTraffic​Group​Identity Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​APPLICATION_​SERVICE_​IDENTITY F5 Load Balancer Application Service Identity.​ F5LBApplication​Service​Identity
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​TRAFFIC_​GROUP_​IDENTITY F5 Load Balancer Traffic Group Identity.​ F5LBTraffic​Group​Identity
OUTPUT_​F5_​LB_​DEVICE_​GROUP_​IDENTITY F5 Load Balancer Device Group Identity.​ F5LBDevice​Group​Identity

Create F5 Load Balancer Device Group

Summary
Create an F5 Load Balancer device group.
Description
This task creates a device group.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Account Select F5 Account F5LBAccount​Identity Y
Select F5 Partition Select F5 Partition F5LBPartition​Identity Y
Name Name gen_​text_​input Y
Description Description gen_​text_​input
ASM Syncronize ASM Synchronize Boolean
Group Type Group Type gen_​text_​input
Auto Syncronize Auto Synchronize Boolean
Full Load On Synchronize Full Load On Ayncronize Boolean
Network Fail​Over Network Fail​Over Boolean
Incremental Config Synchronize Size​Max incremental​Config​Sync​Size​Max gen_​text_​input
Save On Auto Synchronize Save On Auto Syncronize Boolean
Memebers Add one or more Member detail that can be associated with Device Group.​
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity
OUTPUT_​F5_​LB_​DEVICE_​GROUP_​IDENTITY F5 Load Balancer Device Group Identity.​ F5LBDevice​Group​Identity

Create F5 Load Balancer Partitions

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Select F5 Account Select F5 Account F5LBAccount​Identity Y
Partition name Partition name gen_​text_​input Y
Description Description gen_​text_​input
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity

Create F5 Load Balancer Pool

Summary
Create an F5 Load Balancer pool.
Description
This task creates a pool in an F5 Load Balancer.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Account Select F5 Account F5LBAccount​Identity Y
Select F5 Partition Select F5 Partition F5LBPartition​Identity Y
Pool name Pool Name gen_​text_​input Y
Load Balancing method Select Load Balancing method F5LBLoad​Balancing​Identity Y
Use existing Nodes list Add one or more Node detail that can be associated with Virtual Server.​
Add new Nodes list Add one or more Node detail that can be associated with Virtual Server.​
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​POOL_​IDENTITY F5 Load Balancer Pool Identity.​ F5LBPool​Identity

Create F5 Load Balancer Traffic Group

Summary
Create an F5 Load Balancer traffic group.
Description
This task creates a traffic group.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Account Select F5 Account F5LBAccount​Identity Y
Select F5 Partition Select F5 Partition F5LBPartition​Identity Y
Name Name gen_​text_​input Y
Description Description gen_​text_​input
Failover Method Failover Method gen_​text_​input
Ha Load​Factor Ha Load​Factor gen_​text_​input
Auto Failback Time Auto Failback Time gen_​text_​input
Auto Failback Enabled Auto Failback Enabled Boolean
Ha Group Ha Group F5LBHa​Group​Identity
MAC MAC gen_​text_​input
Failover Order Add one or more Failover Order detail that can be associated with Traffic Group.​
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity
OUTPUT_​F5_​LB_​TRAFFIC_​GROUP_​IDENTITY F5 Load Balancer Traffic Group Identity.​ F5LBTraffic​Group​Identity

Create F5 Load Balancer Virtual Server

Summary
Create an F5 Load Balancer virtual server.
Description
This task creates a virtual server in an F5 load balancer.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Account Select F5 Account F5LBAccount​Identity Y
Select F5 Partition Select F5 Partition F5LBPartition​Identity Y
Virtual Server name Virtual Server Name gen_​text_​input Y
Virtual Server Description Virtual Server Description gen_​text_​input
Virtual Server Type Virtual Server Type Y
Destination IP Destination IP Address gen_​text_​input Y
Destination IP Destination IP Address ipv4Address
Destination IP Mask Destination IP Mask Address gen_​text_​input
Destination IP Mask Destination IP Mask Address subnet​Mask
Service Port Service Port gen_​text_​input Y
Port number Enter the valid port number.​ gen_​text_​input Y
Protocol Protocol gen_​text_​input
Protocol TCP Profile(Client) Select Client Protocol TCP Profile F5LBTCPProfile​Client​Identity Y
Protocol TCP Profile(Server) Select Server Protocol TCP Profile F5LBTCPProfile​Server​Identity Y
Protocol UDP Profile(Client) Select Client Protocol UDP Profile F5LBUDPProfile​Client​Identity Y
Protocol UDP Profile(Server) Select Server Protocol UDP Profile F5LBUDPProfile​Server​Identity Y
Default Pool Select the Pool name F5LBPool​Identity
Outputs
Output Description Type
OUTPUT_​F5_​LB_​VIRTUAL_​SERVER_​IDENTITY F5 Load Balancer Virtual Server Address Identity.​ F5LBVirtual​Server​Identity
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​POOL_​IDENTITY F5 Load Balancer Pool Identity.​ F5LBPool​Identity

Delete F5 Load Balancer Application Service

Summary
Delete an F5 Load Balancer application service.
Description
This task deletes the iApp Application Service from an F5 load balancer.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Application Service Select F5 Application Service F5LBApplication​Service​Identity Y
Do you want to delete selected Application​Service? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity

Delete F5 Load Balancer Device Group

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Name Name F5LBDevice​Group​Identity Y
Do you want to delete selected Device Group? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity

Delete F5 Load Balancer Node

Summary
Delete an F5 Load Balancer Node.
Description
This task deletes an F5 Load Balancer node.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Node Select F5 Node F5LBNode​Identity Y
Do you want to delete selected Node? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​NODE_​IDENTITY F5 Load Balancer Node Identity.​ F5LBNode​Identity

Delete F5 Load Balancer Partition

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Select F5 Partition Select F5 Partition F5LBPartition​Identity Y
Do you want to delete selected Application​Service? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity

Delete F5 Load Balancer Pool

Summary
Delete an F5 Load Balancer pool
Description
This task deletes a pool from an F5 load balancer.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Pool Select F5 Pool F5LBPool​Identity Y
Do you want to delete selected Pool? Y
Outputs
No Outputs

Delete F5 Load Balancer Traffic Group

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Name Name F5LBTraffic​Group​Identity Y
Do you want to delete selected Traffic Group? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity

Delete F5 Load Balancer Virtual Server

Summary
Delete an F5 Load Balancer Virtual server.
Description
This task deletes a virtual server from an F5 load balancer.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Virtual Server Select F5 Virtual Server F5LBVirtual​Server​Identity Y
Do you want to delete selected Virtual Server? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​VIRTUAL_​SERVER_​NAME F5 Load Balancer Virtual Server Name.​ F5LBVirtual​Server​Name

Force F5 Load Balancer Traffic Group To Standby

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Name Name F5LBTraffic​Group​Identity Y
Do you want to Force This Traffic Group To Standby ? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity

Modify F5 Load Balancer Application Service

Summary
Modify the iApp Application Service attributes.
Description
This task updates the iApp Application Service attributes, including the virtual server, virtual server port, FQDN names of the virtual servers, and the node list.
Inputs
Input Description Mappable To Type Mandatory
Application Service Select the Application Service Name F5LBApplication​Service​Identity Y
Virtual Server IP Virtual Server IP Address gen_​text_​input Y
Virtual Server Port Virtual Server Port gen_​text_​input Y
FQDN names of Virtual server FQDN names of Virtual server gen_​text_​input Y
Nodes list Add one or more Node detail that can be associated with Virtual Server.​ Y
Inherit Device Group from current Partition/Path Do you want to inherit Device Group from current Partition/Path Y
Device Group Select the Device Group F5LBDevice​Group​Identity Y
Inherit Traffic Group from current Partition/Path Do you want to inherit Traffic Group from current Partition/Path Y
Traffic Group Select the Traffic Group F5LBTraffic​Group​Identity Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​APPLICATION_​SERVICE_​IDENTITY F5 Load Balancer Application Service Identity.​ F5LBApplication​Service​Identity
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​TRAFFIC_​GROUP_​IDENTITY F5 Load Balancer Traffic Group Identity.​ F5LBTraffic​Group​Identity
OUTPUT_​F5_​LB_​DEVICE_​GROUP_​IDENTITY F5 Load Balancer Device Group Identity.​ F5LBDevice​Group​Identity

Modify F5 Load Balancer Device Group

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Name Name F5LBDevice​Group​Identity Y
Description Description gen_​text_​input
ASM Syncronize ASM Synchronize Boolean
Group Type Group Type gen_​text_​input
Auto Syncronize Auto Synchronize Boolean
Full Load On Synchronize Full Load On Ayncronize Boolean
Network Fail​Over Network Fail​Over Boolean
Incremental Config Synchronize Size​Max incremental​Config​Sync​Size​Max gen_​text_​input
Save On Auto Synchronize Save On Auto Syncronize Boolean
Memebers Add one or more Member detail that can be associated with Device Group.​
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity
OUTPUT_​F5_​LB_​DEVICE_​GROUP_​IDENTITY F5 Load Balancer Device Group Identity.​ F5LBDevice​Group​Identity

Modify F5 Load Balancer Traffic Group

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Name Name F5LBTraffic​Group​Identity Y
Description Description gen_​text_​input
Failover Method Failover Method gen_​text_​input
Ha Load​Factor Ha Load​Factor gen_​text_​input
Auto Failback Enabled Auto Failback Enabled Boolean
Ha Group Ha Group F5LBHa​Group​Identity
Auto Failback Time Auto Failback Time gen_​text_​input
MAC MAC gen_​text_​input
Failover Order Add one or more Failover Order detail that can be associated with Traffic Group.​
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​PARTITION_​IDENTITY F5 Load Balancer Partition Identity.​ F5LBPartition​Identity
OUTPUT_​F5_​LB_​TRAFFIC_​GROUP_​IDENTITY F5 Load Balancer Traffic Group Identity.​ F5LBTraffic​Group​Identity

Modify F5 Load Balancer Virtual Server

Summary
Modify an F5 Load Balancer Virtual server.
Description
This task modifies a virtual server in an F5 load balancer.
Inputs
Input Description Mappable To Type Mandatory
Virtual Server Select the Virtual Server Name F5LBVirtual​Server​Identity Y
Virtual Server Description Virtual Server Description
Destination IP Destination IP Address gen_​text_​input Y
Destination IP Mask Destination IP Mask Address gen_​text_​input Y
Service Port Service Port gen_​text_​input Y
Port number Enter the valid port number.​ gen_​text_​input Y
Default Pool Select the Pool name F5LBPool​Identity
Outputs
Output Description Type
OUTPUT_​F5_​LB_​VIRTUAL_​SERVER_​IDENTITY F5 Load Balancer Virtual Server Address Identity.​ F5LBVirtual​Server​Identity
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​POOL_​IDENTITY F5 Load Balancer Pool Identity.​ F5LBPool​Identity

Remove Member from F5 Pool

Summary
Remove a member from an F5 pool.
Description
This task removes a member from an F5 pool in an F5 Load Balancer.
Inputs
Input Description Mappable To Type Mandatory
Select F5 Pool Member Select F5 Pool Member F5LBPool​Member​Identity Y
Do you want to remove selected Pool Member? Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​POOL_​IDENTITY F5 Load Balancer Pool Identity.​ F5LBPool​Identity
OUTPUT_​F5_​LB_​NODE_​IDENTITY F5 Load Balancer Node Identity.​ F5LBNode​Identity

Update F5 Load Balancer Traffic Group to Virtual Server Address

Summary
Description
Inputs
Input Description Mappable To Type Mandatory
Select F5 Virtual Server Address Select F5 Virtual Server Address F5LBVirtual​Server​Address​Identity Y
Inherit Traffic Group from current Partition/Path Do you want to inherit Traffic Group from current Partition/Path Y
Traffic Group Select the Traffic Group F5LBTraffic​Group​Identity Y
Outputs
Output Description Type
OUTPUT_​F5_​LB_​ACCOUNT_​IDENTITY F5 Load Balancer Account Identity.​ F5LBAccount​Identity
OUTPUT_​F5_​LB_​VIRTUAL_​SERVER_​ADDRESS_​IDENTITY F5 Load Balancer Virtual Server Identity.​ F5LBVirtual​Server​Address​Identity
OUTPUT_​F5_​LB_​TRAFFIC_​GROUP_​IDENTITY F5 Load Balancer Traffic Group Identity.​ F5LBTraffic​Group​Identity