f5sdk.bigip

Module for BIG-IP

Example - Basic:

from f5sdk.bigip import ManagementClient

device = ManagementClient('192.0.2.10', user='admin', password='admin')
# get BIG-IP info (version, etc.)
device.get_info()

Example - Token Authentication:

device = ManagementClient('192.0.2.10', token='my_token')

Example - Key-Based Authentication:

device = ManagementClient('192.0.2.10',
                        user='admin',
                        private_key_file='~/my_key',
                        set_user_password='admin')

f5sdk.bigip.extension

Module for BIG-IP extension component configuration, including AS3, DO, TS and CF

Example - Basic:

from f5sdk.bigip import ManagementClient
from f5sdk.bigip.extension import AS3Client, DOClient, TSClient, CFClient

mgmt_client = ManagementClient('192.0.2.10', user='admin', password='admin')
extension_client = AS3Client(mgmt_client)

# install AS3 package
extension_client.package.install()
# check service is available
extension_client.service.is_available()
# configure AS3
extension_client.service.create(config_file='./decl.json')

Example - Specify Component:

do_client = DOClient(mgmt_client)
ts_client = TSClient(mgmt_client)
cf_client = CFClient(mgmt_client)

Example - Specify Component Version:

extension_client = AS3Client(device, version='3.9.0')

f5sdk.bigip.extension.package

Module for BIG-IP extension component package configuration

Example - Basic:

from f5sdk.bigip import ManagementClient
from f5sdk.bigip.extension import AS3Client

mgmt_client = ManagementClient('192.0.2.10', user='admin', password='admin')
extension_client = AS3Client(mgmt_client)

# install AS3 package
as3.package.install()

Example - Uninstall:

extension_client.package.uninstall()

Example - Check if extension component is installed:

extension_client.package.is_installed()

f5sdk.bigip.extension.service

Module for BIG-IP extension component service configuration

Example - Basic:

from f5sdk.bigip import ManagementClient
from f5sdk.bigip.extension import AS3Client

mgmt_client = ManagementClient('192.0.2.10', user='admin', password='admin')
extension_client = AS3Client(mgmt_client)

# configure AS3
extension_client.service.create(config_file='./decl.json')

Example - Show:

extension_client.service.show()

Example - Delete:

extension_client.service.delete()

Example - Is Available:

extension_client.service.is_available()

Example - Show Info:

extension_client.service.show_info()

Example - Show Inspect (DO):

extension_client = DOClient(device)
extension_client.service.show_inspect()

Note

The F5 SDK-Python is currently in early development and we want to hear from you! To provide feedback on F5 SDK-Python or this documentation, you can file a GitHub Issue.