F5 Python SDK Documentation

Transcription

1 F5 Python SDK Documentation Release 0.1.1a1 F5 Networks February 21, 2016

2

3 Contents 1 Introduction Submodules bigip Installation 3 3 Usage 5 4 SDK Contents f f5 package Subpackages Submodules f5.conftest module Module contents Contact 35 6 Copyright 37 7 Support 39 8 License Apache V Contributor License Agreement Python Module Index 43 i

4 ii

5 CHAPTER 1 Introduction This project implements an SDK for the icontrol REST interface for the BigIP. Users of this library can create, edit, update, and delete configuration objects on a BigIP device. 1.1 Submodules bigip Python API for configuring objects on a BIG-IP device and gathering information from the device via the REST API. 1

6 2 Chapter 1. Introduction

7 CHAPTER 2 Installation $> pip install f5-sdk NOTE: If you are using a pre-release version you must use the --pre option with the pip command. 3

8 4 Chapter 2. Installation

9 CHAPTER 3 Usage from f5.bigip import BigIP bigip = BigIP("bigip.example.com", "admin", "somepassword") pools = bigip.ltm.pool.getcollection() 5

10 6 Chapter 3. Usage

11 CHAPTER 4 SDK Contents 4.1 f f5 package Subpackages f5.bigip package Subpackages f5.bigip.cm package Subpackages Submodules f5.bigip.cm.cluster module class f5.bigip.cm.cluster.cluster(bigip) Bases: object add_devices(*args, **kwargs) add_peer(*args, **kwargs) cluster_exists(*args, **kwargs) create(*args, **kwargs) create_traffic_group(*args, **kwargs) delete(*args, **kwargs) 7

12 delete_traffic_group(*args, **kwargs) devices(*args, **kwargs) disable_auto_sync(*args, **kwargs) enable_auto_sync(*args, **kwargs) get_local_device_addr(*args, **kwargs) get_local_device_name(*args, **kwargs) get_metadata(*args, **kwargs) get_peer_addr(*args, **kwargs) get_sync_color(*args, **kwargs) get_sync_status(*args, **kwargs) get_traffic_groups(*args, **kwargs) peer_exists(*args, **kwargs) remove_all_devices(*args, **kwargs) remove_device(*args, **kwargs) remove_devices(*args, **kwargs) remove_metadata(*args, **kwargs) save_config(*args, **kwargs) set_metadata(*args, **kwargs) sync(*args, **kwargs) sync_failover_dev_group_exists(*args, **kwargs) sync_local_device_to_group(*args, **kwargs) 8 Chapter 4. SDK Contents

13 traffic_group_exists(*args, **kwargs) update_metadata(*args, **kwargs) update_traffic_group(*args, **kwargs) wait_for_insync_status(*args, **kwargs) f5.bigip.cm.device module class f5.bigip.cm.device.device(bigip) Bases: object get_all_device_names(*args, **kwargs) get_all_mgmt_addrs(*args, **kwargs) get_configsync_addr(*args, **kwargs) get_device_group(*args, **kwargs) get_device_name(*args, **kwargs) get_failover_addrs(*args, **kwargs) get_failover_state(*args, **kwargs) get_lock(*args, **kwargs) get_metadata(*args, **kwargs) get_mgmt_addr(*args, **kwargs) get_mgmt_addr_by_device(*args, **kwargs) get_primary_mirror_addr(*args, **kwargs) get_secondary_mirror_addr(*args, **kwargs) release_lock(*args, **kwargs) remove_all_peers(*args, **kwargs) remove_from_device_group(*args, **kwargs) 4.1. f5 9

14 remove_metadata(*args, **kwargs) reset_trust(*args, **kwargs) set_configsync_addr(*args, **kwargs) set_failover_addrs(*args, **kwargs) set_metadata(*args, **kwargs) set_primary_mirror_addr(*args, **kwargs) set_secondary_mirror_addr(*args, **kwargs) update_metadata(*args, **kwargs) Module contents class f5.bigip.cm.cm(bigip) Bases: object cluster device f5.bigip.ltm package Subpackages Submodules f5.bigip.ltm.monitor module class f5.bigip.ltm.monitor.dns(dns_collection) class f5.bigip.ltm.monitor.dnscollection(monitor) class f5.bigip.ltm.monitor.diameter(diameter_collection) class f5.bigip.ltm.monitor.diametercollection(monitor) class f5.bigip.ltm.monitor.external(external_collection) class f5.bigip.ltm.monitor.externalcollection(monitor) class f5.bigip.ltm.monitor.ftp(ftp_collection) 10 Chapter 4. SDK Contents

15 class f5.bigip.ltm.monitor.ftpcollection(monitor) class f5.bigip.ltm.monitor.firepass(firepass_collection) class f5.bigip.ltm.monitor.firepasscollection(monitor) class f5.bigip.ltm.monitor.gateway_icmp(gateway_icmp_collection) class f5.bigip.ltm.monitor.gateway_icmpcollection(monitor) class f5.bigip.ltm.monitor.http(http_collection) class f5.bigip.ltm.monitor.httpcollection(monitor) class f5.bigip.ltm.monitor.https(https_collection) class f5.bigip.ltm.monitor.httpscollection(monitor) class f5.bigip.ltm.monitor.icmp(icmp_collection) class f5.bigip.ltm.monitor.icmpcollection(monitor) class f5.bigip.ltm.monitor.imap(imap_collection) class f5.bigip.ltm.monitor.imapcollection(monitor) class f5.bigip.ltm.monitor.inband(inband_collection) class f5.bigip.ltm.monitor.inbandcollection(monitor) class f5.bigip.ltm.monitor.ldap(ldap_collection) class f5.bigip.ltm.monitor.ldapcollection(monitor) class f5.bigip.ltm.monitor.mssql(mssql_collection) class f5.bigip.ltm.monitor.mssqlcollection(monitor) class f5.bigip.ltm.monitor.mysql(mysql_collection) class f5.bigip.ltm.monitor.mysqlcollection(monitor) 4.1. f5 11

16 class f5.bigip.ltm.monitor.module_score(gateway_icmp_collection) class f5.bigip.ltm.monitor.module_scorecollection(monitor) class f5.bigip.ltm.monitor.monitor(ltm) Bases: f5.bigip.resource.organizingcollection class f5.bigip.ltm.monitor.nntp(nntp_collection) class f5.bigip.ltm.monitor.nntpcollection(monitor) class f5.bigip.ltm.monitor.none(none_collection) class f5.bigip.ltm.monitor.nonecollection(monitor) class f5.bigip.ltm.monitor.oracle(oracle_collection) class f5.bigip.ltm.monitor.oraclecollection(monitor) class f5.bigip.ltm.monitor.pop3(pop3_collection) class f5.bigip.ltm.monitor.pop3collection(monitor) class f5.bigip.ltm.monitor.postgresql(postgresql_collection) class f5.bigip.ltm.monitor.postgresqlcollection(monitor) class f5.bigip.ltm.monitor.rpc(rpc_collection) class f5.bigip.ltm.monitor.rpccollection(monitor) class f5.bigip.ltm.monitor.radius(radius_collection) class f5.bigip.ltm.monitor.radiuscollection(monitor) class f5.bigip.ltm.monitor.radius_accounting(radius_accounting_collection) class f5.bigip.ltm.monitor.radius_accountingcollection(monitor) class f5.bigip.ltm.monitor.real_server(real_server_collection) update(**kwargs) class f5.bigip.ltm.monitor.real_servercollection(monitor) 12 Chapter 4. SDK Contents

17 class f5.bigip.ltm.monitor.sasp(sasp_collection) class f5.bigip.ltm.monitor.saspcollection(monitor) class f5.bigip.ltm.monitor.sip(sip_collection) class f5.bigip.ltm.monitor.sipcollection(monitor) class f5.bigip.ltm.monitor.smb(smb_collection) class f5.bigip.ltm.monitor.smbcollection(monitor) class f5.bigip.ltm.monitor.smtp(smtp_collection) class f5.bigip.ltm.monitor.smtpcollection(monitor) class f5.bigip.ltm.monitor.snmp_dca(snmp_dca_collection) class f5.bigip.ltm.monitor.snmp_dcacollection(monitor) class f5.bigip.ltm.monitor.snmp_dca_base(snmp_dca_base_collection) class f5.bigip.ltm.monitor.snmp_dca_basecollection(monitor) class f5.bigip.ltm.monitor.soap(soap_collection) class f5.bigip.ltm.monitor.soapcollection(monitor) class f5.bigip.ltm.monitor.scripted(scripted_collection) class f5.bigip.ltm.monitor.scriptedcollection(monitor) class f5.bigip.ltm.monitor.tcp(tcp_collection) class f5.bigip.ltm.monitor.tcpcollection(monitor) class f5.bigip.ltm.monitor.tcp_echo(tcp_echo_collection) class f5.bigip.ltm.monitor.tcp_echocollection(monitor) class f5.bigip.ltm.monitor.tcp_half_open(tcp_half_open_collection) 4.1. f5 13

18 class f5.bigip.ltm.monitor.tcp_half_opencollection(monitor) class f5.bigip.ltm.monitor.udp(udp_collection) class f5.bigip.ltm.monitor.udpcollection(monitor) class f5.bigip.ltm.monitor.updatemonitormixin Bases: object update(**kwargs) class f5.bigip.ltm.monitor.virtual_location(virtual_location_collection) class f5.bigip.ltm.monitor.virtual_locationcollection(monitor) class f5.bigip.ltm.monitor.wap(wap_collection) class f5.bigip.ltm.monitor.wapcollection(monitor) class f5.bigip.ltm.monitor.wmi(wmi_collection) update(**kwargs) class f5.bigip.ltm.monitor.wmicollection(monitor) f5.bigip.ltm.nat module class f5.bigip.ltm.nat.nat(nat_collection) Bases: f5.bigip.resource.resource create(**kwargs) update(**kwargs) class f5.bigip.ltm.nat.natcollection(ltm) f5.bigip.ltm.policy module class f5.bigip.ltm.policy.actions(actions_collection) Bases: f5.bigip.resource.resource class f5.bigip.ltm.policy.actionscollection(rules) class f5.bigip.ltm.policy.conditions(conditions_collection) Bases: f5.bigip.resource.resource class f5.bigip.ltm.policy.conditionscollection(rules) class f5.bigip.ltm.policy.policy(policy_collection) Bases: f5.bigip.resource.resource class f5.bigip.ltm.policy.policycollection(ltm) 14 Chapter 4. SDK Contents

19 class f5.bigip.ltm.policy.rules(rules_collection) Bases: f5.bigip.resource.resource class f5.bigip.ltm.policy.rulescollection(policy) f5.bigip.ltm.pool module class f5.bigip.ltm.pool.member(member_collection) Bases: f5.bigip.resource.resource update(**kwargs) exception f5.bigip.ltm.pool.memberstatealwaysrequiredonupdate Bases: exceptions.exception class f5.bigip.ltm.pool.memberscollection(pool) class f5.bigip.ltm.pool.pool(pool_collection) Bases: f5.bigip.resource.resource class f5.bigip.ltm.pool.poolcollection(ltm) f5.bigip.ltm.rule module class f5.bigip.ltm.rule.rule(rule_collection) Bases: f5.bigip.resource.resource create(**kwargs) delete() load(**kwargs) refresh() update(**kwargs) class f5.bigip.ltm.rule.rulecollection(ltm) f5.bigip.ltm.snat module exception f5.bigip.ltm.snat.requireoneof Bases: f5.bigip.resource.missingrequiredcreationparameter class f5.bigip.ltm.snat.snat(snat_collection) Bases: f5.bigip.resource.resource create(**kwargs) class f5.bigip.ltm.snat.snatcollection(ltm) f5.bigip.ltm.ssl module class f5.bigip.ltm.ssl.ssl(ltm_instance) Bases: object Interface for SSL related REST methods 4.1. f5 15

20 class Certificate(name=None, cert=none, key=none, pkcs12=none, passphrase=none) Bases: object Provides import and download capability for X.509 certificates. certifcate_id = None certificate_data = None certificate_from_pem_data(pem_data=none) expiration_date = None from_pkcs12_data(pkcs12_data=none, import_passphrase=none) get_pem_certificate(url=none) get_pem_key(url=none, key_passphrase= ) get_pkcs12(url=none, import_passphrase=none) id_from_subject_cn() issuer_cn = None key_from_pem_data(pem_data=none, key_passphrase= ) key_length = 0 key_passphrase_required = False serial_number = None subject_cn = None version = None SSL.OBJ_PREFIX = uuid_ SSL.all_client_profile_names(*args, **kwargs) SSL.client_profile_exits(*args, **kwargs) SSL.create_clientssl_profile_for_certificate(*args, **kwargs) SSL.remove_clientssl_profile_and_certificate(*args, **kwargs) f5.bigip.ltm.virtual module class f5.bigip.ltm.virtual.virtual(virtual_collection) Bases: f5.bigip.resource.resource class f5.bigip.ltm.virtual.virtualcollection(ltm) Module contents class f5.bigip.ltm.ltm(bigip) Bases: f5.bigip.resource.organizingcollection f5.bigip.net package 16 Chapter 4. SDK Contents

21 Subpackages Submodules f5.bigip.net.arp module class f5.bigip.net.arp.arp(bigip) Bases: object Class for configuring ARP on bigip create(*args, **kwargs) delete(*args, **kwargs) delete_all(*args, **kwargs) delete_by_mac(*args, **kwargs) Classes and functions for configuring ARP on bigip delete_by_subnet(*args, **kwargs) exists(*args, **kwargs) get_arps(*args, **kwargs) f5.bigip.net.interface module class f5.bigip.net.interface.interface(bigip) Bases: object Class for managing irules on bigip get_interface_macaddresses_dict() Get dictionary of mac addresses keyed by their interface name get_interfaces() Get interface names get_mac_addresses() Get MAC addresses for all interfaces f5.bigip.net.l2gre module class f5.bigip.net.l2gre.l2gre(bigip) Bases: object add_fdb_entries(*args, **kwargs) add_fdb_entry(*args, **kwargs) create_multipoint_profile(*args, **kwargs) 4.1. f5 17

22 create_multipoint_tunnel(*args, **kwargs) delete_all(*args, **kwargs) delete_all_fdb_entries(*args, **kwargs) delete_fdb_entries(*args, **kwargs) delete_fdb_entry(*args, **kwargs) delete_profile(*args, **kwargs) delete_tunnel(*args, **kwargs) get_fdb_entry(*args, **kwargs) get_profiles(*args, **kwargs) get_tunnel_by_description(*args, **kwargs) get_tunnel_folder(*args, **kwargs) get_tunnel_key(*args, **kwargs) get_tunnels(*args, **kwargs) profile_exists(*args, **kwargs) tunnel_exists(*args, **kwargs) f5.bigip.net.route module class f5.bigip.net.route.route(bigip) Bases: object add_vlan_to_domain(*args, **kwargs) add_vlan_to_domain_by_id(*args, **kwargs) create(*args, **kwargs) create_domain(*args, **kwargs) delete(*args, **kwargs) 18 Chapter 4. SDK Contents

23 delete_all(*args, **kwargs) delete_domain(*args, **kwargs) domain_exists(*args, **kwargs) exists(*args, **kwargs) get_domain(*args, **kwargs) get_domain_by_id(*args, **kwargs) get_domain_ids(*args, **kwargs) get_domain_names(*args, **kwargs) get_vlans_in_domain(*args, **kwargs) get_vlans_in_domain_by_id(*args, **kwargs) remove_vlan_from_domain(*args, **kwargs) set_strict_state(*args, **kwargs) f5.bigip.net.selfip module class f5.bigip.net.selfip.selfip(selfip_collection) Bases: f5.bigip.resource.resource This represents a Self IP. Use this object to create, refresh, update, delete, and load self ip configuration on the BIGIP. This requires that a vlan object be present on the system and that object s :attrib: fullpath be used as the vlan name. The address that is used for create is a <ipaddress>/<netmask>. For example /32. NOTE: The object is actully called self in icontrolrest, but obviously this will cause problems in Python so we changed its name to SelfIP. This is why the the SelfIPCollection s uri ends in self/ not selfip/ create(**kwargs) class f5.bigip.net.selfip.selfipcollection(net) This represents a collection of Self IPs. NOTE: The objects in the collection are actually called self in icontrolrest, but obviously this will cause problems in Python so we changed its name to SelfIP. This is why the the SelfIPCollection s uri ends in self/ not selfip/. We override the object s _meta_data[ uri ] to account for this f5 19

24 f5.bigip.net.vlan module class f5.bigip.net.vlan.interfaces(interfaces_collection) Bases: f5.bigip.resource.resource, f5.bigip.mixins.exclusiveattributesmixin create(**kwargs) load(**kwargs) class f5.bigip.net.vlan.interfacescollection(vlan) Represents a VLAN interface list. Not to be confused with tm/mgmt/net/interface. This is actually called interfaces with an s by the BIGIP s REST API. Note We may need to come back and revist this if it turns out that the actual representation of the interface and interfaces objects are the same. class f5.bigip.net.vlan.vlan(vlan_collection) Bases: f5.bigip.resource.resource class f5.bigip.net.vlan.vlancollection(net) f5.bigip.net.vxlan module vxlan.py class f5.bigip.net.vxlan.vxlan(bigip) Bases: object Interface for vxlan related REST methods OBJ_PREFIX = uuid_ add_fdb_entries(*args, **kwargs) add_fdb_entry(*args, **kwargs) create_multipoint_profile(*args, **kwargs) create_multipoint_tunnel(*args, **kwargs) delete_all(*args, **kwargs) delete_all_fdb_entries(*args, **kwargs) delete_fdb_entries(*args, **kwargs) delete_fdb_entry(*args, **kwargs) delete_profile(*args, **kwargs) delete_tunnel(*args, **kwargs) 20 Chapter 4. SDK Contents

25 get_fdb_entry(*args, **kwargs) get_profiles(*args, **kwargs) get_tunnel_by_description(*args, **kwargs) get_tunnel_folder(*args, **kwargs) get_tunnel_key(*args, **kwargs) get_tunnels(*args, **kwargs) profile_exists(*args, **kwargs) tunnel_exists(*args, **kwargs) Module contents class f5.bigip.net.net(bigip) Bases: f5.bigip.resource.organizingcollection f5.bigip.pycontrol package Subpackages Submodules f5.bigip.pycontrol.pycontrol module class f5.bigip.pycontrol.pycontrol.bigip(hostname=none, username=none, password=none, wsdls=none, directory=none, fromurl=false, debug=false, proto= https, sessions=false, cache=true, **kwargs) Bases: object Wrap suds client object(s) and create a user-friendly class to use. add_interface(wsdl) add_interfaces(wsdls) get_sessionid() Fetch a session identifier from a v11.x BigIP. static set_sessionid(sessionid, client) Sets the session header for a (String) - session_id to add to the X-iControl-Session - client object. set_timeout(timeout) 4.1. f5 21

26 class f5.bigip.pycontrol.pycontrol.httpsunverifiedcerttransport(*args, **kwargs) Bases: suds.transport.https.httpauthenticated u2handlers() class f5.bigip.pycontrol.pycontrol.inmemorycache Bases: suds.cache.cache In-memory cache. The contents of the cache is shared between all instances. clear() data = {} get(objid) getf(objid) purge(objid) put(objid, obj) putf(objid, fp) class f5.bigip.pycontrol.pycontrol.interfaceinstance(name) Bases: object An icontrol interface object to set attributes against. class f5.bigip.pycontrol.pycontrol.moduleinstance(name) Bases: object An icontrol module object to set attributes against. class f5.bigip.pycontrol.pycontrol.roclient(url, **kwargs) Bases: suds.client.client f5.bigip.pycontrol.pycontrol.main() Module contents exception f5.bigip.pycontrol.f5error(e) Bases: exceptions.exception f5.bigip.sys package Subpackages Submodules f5.bigip.sys.application module Manage application services on BIG-IP using REST interface class f5.bigip.sys.application.aplscript(apl_script_collection) Bases: f5.bigip.resource.resource class f5.bigip.sys.application.aplscriptcollection(application) class f5.bigip.sys.application.applicationcollection(sys) 22 Chapter 4. SDK Contents

27 class f5.bigip.sys.application.customstat(custom_stat_collection) Bases: f5.bigip.resource.resource class f5.bigip.sys.application.customstatcollection(application) class f5.bigip.sys.application.service(service_collection) Bases: f5.bigip.resource.resource update(**kwargs) Push local updates to the object on the device. Params kwargs keyword arguments for accessing/modifying the object Returns updated Python object class f5.bigip.sys.application.servicecollection(application) class f5.bigip.sys.application.template(template_collection) Bases: f5.bigip.resource.resource class f5.bigip.sys.application.templatecollection(application) f5.bigip.sys.folder module class f5.bigip.sys.folder.folder(folder_collection) Bases: f5.bigip.resource.resource update(**kwargs) Update the object, removing device group if inherited If inheriteddevicegroup is the string true we need to remove devicegroup from the args before we update or we get the following error: The floating traffic-group: /Common/traffic-group-1 can only be set on /testfolder if its device-group is inherited from the root folder class f5.bigip.sys.folder.foldercollection(sys) f5.bigip.sys.stat module class f5.bigip.sys.stat.stat(bigip) Bases: object Class for accessing bigip statistics get_active_ssl_tps(*args, **kwargs) get_active_connection_count(*args, **kwargs) get_composite_score(*args, **kwargs) get_cps_health_score(*args, **kwargs) get_cpu_health_score(*args, **kwargs) 4.1. f5 23

28 get_global_statistics(*args, **kwargs) get_inbound_throughput(*args, **kwargs) get_mem_health_score(*args, **kwargs) get_outbound_throughput(*args, **kwargs) get_throughput(*args, **kwargs) f5.bigip.sys.system module class f5.bigip.sys.system.system(bigip) Bases: object Class for configuring bigip system OBJ_PREFIX = uuid_ create_folder(*args, **kwargs) delete_folder(*args, **kwargs) folder_exists(*args, **kwargs) Classes and functions for configuring bigip system force_root_folder() Force icontrol SOAP context into root folder. This is typically done before deleting a folder. We need to ensure the internal context of the icontrol SOAP portal is not associated with a folder before the folder is deleted or the SOAP portal will become inoperative. We need to do a fake query and fake command because setting your active folder, by itself, does not do anything. force_to_standby(*args, **kwargs) get_active_modules(*args, **kwargs) get_folders(*args, **kwargs) get_hostname(*args, **kwargs) get_license_operational(*args, **kwargs) get_major_version(*args, **kwargs) get_minor_version(*args, **kwargs) 24 Chapter 4. SDK Contents

29 get_ntp_server(*args, **kwargs) get_platform(*args, **kwargs) get_provision_extramb(*args, **kwargs) get_serial_number(*args, **kwargs) get_tunnel_sync(*args, **kwargs) get_version(*args, **kwargs) purge_all_folders(*args, **kwargs) purge_folder(*args, **kwargs) purge_folder_contents(*args, **kwargs) purge_orphaned_folders(*args, **kwargs) purge_orphaned_folders_contents(*args, **kwargs) set_folder(*args, **kwargs) set_hostname(*args, **kwargs) set_ntp_server(*args, **kwargs) set_provision_extramb(*args, **kwargs) set_tunnel_sync(*args, **kwargs) Module contents class f5.bigip.sys.sys(bigip) Bases: f5.bigip.resource.organizingcollection Submodules f5.bigip.dynamic_attributes module class f5.bigip.dynamic_attributes.lazyattributemixin Bases: object 4.1. f5 25

30 f5.bigip.exceptions module exception f5.bigip.exceptions.bigipclusterconfigsavefailure exception f5.bigip.exceptions.bigipclusterinvalidha exception f5.bigip.exceptions.bigipclusterpeeraddfailure exception f5.bigip.exceptions.bigipclustersyncfailure exception f5.bigip.exceptions.bigipdevicelockacquirefailed exception f5.bigip.exceptions.bigipexception Bases: exceptions.exception exception f5.bigip.exceptions.clustercreationexception exception f5.bigip.exceptions.clusterdeleteexception exception f5.bigip.exceptions.clusterqueryexception exception f5.bigip.exceptions.clusterupdateexception exception f5.bigip.exceptions.createalreadyextantresource exception f5.bigip.exceptions.devicecreationexception exception f5.bigip.exceptions.devicedeleteexception exception f5.bigip.exceptions.devicequeryexception exception f5.bigip.exceptions.deviceupdateexception exception f5.bigip.exceptions.iappcreationexception exception f5.bigip.exceptions.iappdeleteexception exception f5.bigip.exceptions.iappqueryexception exception f5.bigip.exceptions.iappupdateexception exception f5.bigip.exceptions.interfacequeryexception exception f5.bigip.exceptions.invalidnetworktype 26 Chapter 4. SDK Contents

31 exception f5.bigip.exceptions.l2gretunnelcreationexception exception f5.bigip.exceptions.l2gretunneldeleteexception exception f5.bigip.exceptions.l2gretunnelqueryexception exception f5.bigip.exceptions.l2gretunnelupdateexception exception f5.bigip.exceptions.majorversionvalidatefailed exception f5.bigip.exceptions.minorversionvalidatefailed exception f5.bigip.exceptions.missingnetwork exception f5.bigip.exceptions.missingvtepaddress exception f5.bigip.exceptions.monitorcreationexception exception f5.bigip.exceptions.monitordeleteexception exception f5.bigip.exceptions.monitorqueryexception exception f5.bigip.exceptions.monitorupdateexception exception f5.bigip.exceptions.natcreationexception exception f5.bigip.exceptions.natdeleteexception exception f5.bigip.exceptions.natqueryexception exception f5.bigip.exceptions.natupdateexception exception f5.bigip.exceptions.poolcreationexception exception f5.bigip.exceptions.pooldeleteexception exception f5.bigip.exceptions.poolqueryexception exception f5.bigip.exceptions.poolupdateexception exception f5.bigip.exceptions.provisioningextrambvalidatefailed 4.1. f5 27

32 exception f5.bigip.exceptions.routecreationexception exception f5.bigip.exceptions.routedeleteexception exception f5.bigip.exceptions.routequeryexception exception f5.bigip.exceptions.routeupdateexception exception f5.bigip.exceptions.rulecreationexception exception f5.bigip.exceptions.ruledeleteexception exception f5.bigip.exceptions.rulequeryexception exception f5.bigip.exceptions.ruleupdateexception exception f5.bigip.exceptions.snatcreationexception exception f5.bigip.exceptions.snatdeleteexception exception f5.bigip.exceptions.snatqueryexception exception f5.bigip.exceptions.snatupdateexception exception f5.bigip.exceptions.selfipcreationexception exception f5.bigip.exceptions.selfipdeleteexception exception f5.bigip.exceptions.selfipqueryexception exception f5.bigip.exceptions.selfipupdateexception exception f5.bigip.exceptions.staticarpcreationexception exception f5.bigip.exceptions.staticarpdeleteexception exception f5.bigip.exceptions.staticarpqueryexception exception f5.bigip.exceptions.systemcreationexception exception f5.bigip.exceptions.systemdeleteexception 28 Chapter 4. SDK Contents

33 exception f5.bigip.exceptions.systemqueryexception exception f5.bigip.exceptions.systemupdateexception exception f5.bigip.exceptions.unknownmonitortype exception f5.bigip.exceptions.vlancreationexception exception f5.bigip.exceptions.vlandeleteexception exception f5.bigip.exceptions.vlanqueryexception exception f5.bigip.exceptions.vlanupdateexception exception f5.bigip.exceptions.vxlancreationexception exception f5.bigip.exceptions.vxlandeleteexception exception f5.bigip.exceptions.vxlanqueryexception exception f5.bigip.exceptions.vxlanupdateexception exception f5.bigip.exceptions.virtualservercreationexception exception f5.bigip.exceptions.virtualserverdeleteexception exception f5.bigip.exceptions.virtualserverqueryexception exception f5.bigip.exceptions.virtualserverupdateexception f5.bigip.mixins module class f5.bigip.mixins.exclusiveattributesmixin Bases: object class f5.bigip.mixins.lazyattributemixin Bases: object exception f5.bigip.mixins.lazyattributesrequired Bases: exceptions.exception class f5.bigip.mixins.todictmixin Bases: object Containers = (<type tuple >, <type list >, <type set >, <type frozenset >, <type dict >) to_dict() traversed = {} 4.1. f5 29

34 f5.bigip.resource module This module provides classes that specify how RESTful resources are handled. There are different types of resources published by the BigIP REST Server, they are represented by the classes in this module. Available Classes: ResourceBase only read is generally supported in all resource types, this class provides read. Resource- Base objects are usually instantiated via setting lazy attributes. ResourceBase provides a contructor to match the lazy constructor. The expected behavior is that all resource subclasses depend on this constructor to correctly set their self._meta_data[ uri ]. All ResourceBase objects (except BigIPs) have a container (BigIPs contain themselves). The container is the object the ResourceBase is an attribute of. Collection These resources support lists of ResourceBase Objects. Resource These resources are the only resources that support create, update, and delete operations. Because they support HTTP post (via _create) they uniquely depend on 2 uri s, a uri that supports the creating post, and the returned uri of the newly created resource. InvalidResource resources do not generally support all 5 Resource operations, if a caller attempts to invoke an unsupported operation this Exception is raised. class f5.bigip.resource.collection(container) Bases: f5.bigip.resource.resourcebase Inherit from this class if the corresponding uri lists other resources. Note any subclass must have Collection at the end of its name! get_collection() Get an iterator (list maybe upgrade to generator) of objects. The objects in returned list are Pythonic ResourceBases that map to the most recently got state of urisresources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server. exception f5.bigip.resource.deviceprovidesincompatiblekey Bases: exceptions.exception exception f5.bigip.resource.generationmismatch Bases: exceptions.exception exception f5.bigip.resource.invalidforcetype Bases: exceptions.valueerror exception f5.bigip.resource.invalidresource Bases: exceptions.exception Raise this when a caller tries to invoke an unsupported CUD op. All resources support read. Only Resources support create, update, and delete. exception f5.bigip.resource.kindtypemismatch Bases: exceptions.exception exception f5.bigip.resource.missingrequiredcreationparameter Bases: exceptions.exception exception f5.bigip.resource.missingrequiredreadparameter Bases: exceptions.exception class f5.bigip.resource.organizingcollection(bigip) Bases: f5.bigip.resource.resourcebase get_collection() 30 Chapter 4. SDK Contents

35 class f5.bigip.resource.resource(container) Bases: f5.bigip.resource.resourcebase Use this to represent a Configurable Resource on the device. 1a. bigip.ltm.natcollection.nat or 1b. nat_obj = bigip.ltm.natcollection.nat 2. call super(subclass, self). init (container) in its init create(**kwargs) delete() load(**kwargs) update(**kwargs) class f5.bigip.resource.resourcebase(container) Bases: f5.bigip.mixins.lazyattributemixin, f5.bigip.mixins.todictmixin Every resource that maps to a uri on the device should inherit this. Instantiate this with ContainerInstance.NewResourceBaseInstance via the LazyAttributeMixin. The BigIP is represented by an object that converts device published uri s into Python objects. Each uri maps to a Python object. The mechanism for instantatiating these objects is the getattr Special Function in the LazyAttributeMixin. When a registered attribute is dot referenced, on the device object (e.g. bigip.ltm or simply bigip), an appropriate object is instantiated and attributed to the referencing object, so: >>> bigip.ltm = LTM(bigip) >>> bigip.ltm.natcollection >>> nat1 = bigip.ltm.natcollection.nat.create( Foo, Bar, , ) Shortens to just the last line: >>> nat1 = bigip.ltm.natcollection.nat.create( Foo, Bar, , ) More importantly is enforces a convention relating device published uris to API objects, in a hierarchy similar to the uri paths. I.E. the uri corresponding to a NatCollection object is mgmt/tm/ltm/nat/. If you query the bigip s uri (e.g. print(bigip._meta_data[ uri ]) ), you ll see that it ends in: mgmt/tm/, if you query the ltm object s uri (e.g. print(bigip.ltm._meta_data[ uri ]) ) you ll see it ends in mgmt/tm/ltm/. In general the objects build a required self._meta_data[ uri ] attribute by: 1. Inheriting this class. 2. calling super(subclass, self). init (container) 3. self.uri = self.container_uri + base_uri < Always defined in the module that defines the class. The net result is a reasonably succinct mapping between uri s and objects, that represents objects in a hierarchical relationship similar to the devices uri path hierarchy. This is the class that defines read for all ResourceBases. Public attributes: - read: updates itself with the results of an http GET on the resource - others: not to be called here create() delete() load(**kwargs) raw refresh() update() exception f5.bigip.resource.uricreationcollision Bases: exceptions.exception 4.1. f5 31

36 exception f5.bigip.resource.unregisteredkind Bases: exceptions.exception f5.bigip.rest_collection module BIG-IP API RESTInterfaceCollection class f5.bigip.rest_collection.restinterfacecollection Bases: object Abstract base class for collection objects. delete(*args, **kwargs) delete_all(*args, **kwargs) exists(*args, **kwargs) f5.bigip.rest_collection.decorate_name(name=none, folder= Common, use_prefix=true) Add namespace prefix to names f5.bigip.rest_collection.icontrol_folder(method) Returns the icontrol folder + object name. If a kwarg name is name or else ends in _name. The folder and the name will be prefixed with the global prefix OBJ_PREFIX. If preserve_vlan_name=true is an argument, then the vlan_name argument will not be prefixed but the other matching arguments will. It also sets the icontrol active folder to folder kwarg assuring get_list returns just the appopriate objects for the specific administrative partition. It does this for kwarg named name, ends in _name, or named_address. If the value in the name already includes /Common/ the decoration honors that full path. f5.bigip.rest_collection.icontrol_rest_folder(method) Returns icontrol REST folder + object name. If a kwarg name is name or else ends in _name. The folder and the name will be prefixed with the global prefix OBJ_PREFIX. f5.bigip.rest_collection.log(method) Decorator helping to log method calls. f5.bigip.rest_collection.prefixed(name) Put object prefix in front of name f5.bigip.rest_collection.split_addr_port(dest) f5.bigip.rest_collection.strip_domain_address(ip_address) Strip domain from ip address f5.bigip.rest_collection.strip_folder_and_prefix(path) Strip folder and prefix Module contents Classes and functions for configuring BIG-IP class f5.bigip.bigip(hostname, username, password, **kwargs) Bases: f5.bigip.resource.organizingcollection An interface to a single BIG-IP 32 Chapter 4. SDK Contents

37 f5.common package Subpackages Submodules f5.common.constants module f5.common.iapp_parser module exception f5.common.iapp_parser.curlybracemismatchexception Bases: exceptions.exception exception f5.common.iapp_parser.emptytemplateexception Bases: exceptions.exception class f5.common.iapp_parser.iappparser(template_str) Bases: object get_section_end_index(section, section_start) Get end of section s content. Parameters section string name of section section_start integer index of section s beginning Returns integer index of section s end Raises CurlyBraceMismatchException get_section_start_index(section) Get start of a section s content. Parameters section string name of section Returns integer index of section s beginning Raises NonextantSectionException get_template_attr(attr) Find the attribute value for a specific attribute. Parameters attr string of attribute name Returns string of attribute value get_template_name() Find template name. Returns string of template name Raises NonextantTemplateNameException parse_template() Parse the template string into a dict. Find the (large) inner sections first, save them, and remove them from a modified string. Then find the template attributes in the modified string. Returns dictionary of parsed template template_attrs = [u description, u partition ] 4.1. f5 33

38 template_sections = [u presentation, u implementation, u html-help, u role-acl ] exception f5.common.iapp_parser.nonextantsectionexception Bases: exceptions.exception exception f5.common.iapp_parser.nonextanttemplatenameexception Bases: exceptions.exception f5.common.logger module class f5.common.logger.log Bases: object static crit(prefix, msg) static debug(prefix, msg) static error(prefix, msg) static info(prefix, msg) Module contents Submodules f5.conftest module Module contents 34 Chapter 4. SDK Contents

39 CHAPTER 5 Contact f5_common_python@f5.com 35

40 36 Chapter 5. Contact

41 CHAPTER 6 Copyright Copyright F5 Networks Inc. 37

42 38 Chapter 6. Copyright

43 CHAPTER 7 Support Maintenance and support of the unmodified F5 code is provided only to customers who have an existing support contract, purchased separately subject to F5 s support policies available at and F5 will not provide maintenance and support services of modified F5 code or code that does not have an existing support contract. 39

44 40 Chapter 7. Support

45 CHAPTER 8 License 8.1 Apache V2.0 Licensed under the Apache License, Version 2.0 (the License ); you may not use this file except in compliance with the License. You may obtain a copy of the License at Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 8.2 Contributor License Agreement Individuals or business entities who contribute to this project must have completed and submitted the F5 Contributor License Agreement to Openstack_CLA@f5.com prior to their code submission being included in this project. 41

46 42 Chapter 8. License

47 Python Module Index f f5, 34 f5.bigip, 32 f5.bigip.cm, 10 f5.bigip.cm.cluster, 7 f5.bigip.cm.device, 9 f5.bigip.dynamic_attributes, 25 f5.bigip.exceptions, 26 f5.bigip.ltm, 16 f5.bigip.ltm.monitor, 10 f5.bigip.ltm.nat, 14 f5.bigip.ltm.policy, 14 f5.bigip.ltm.pool, 15 f5.bigip.ltm.rule, 15 f5.bigip.ltm.snat, 15 f5.bigip.ltm.ssl, 15 f5.bigip.ltm.virtual, 16 f5.bigip.mixins, 29 f5.bigip.net, 21 f5.bigip.net.arp, 17 f5.bigip.net.interface, 17 f5.bigip.net.l2gre, 17 f5.bigip.net.route, 18 f5.bigip.net.selfip, 19 f5.bigip.net.vlan, 20 f5.bigip.net.vxlan, 20 f5.bigip.pycontrol, 22 f5.bigip.pycontrol.pycontrol, 21 f5.bigip.resource, 30 f5.bigip.rest_collection, 32 f5.bigip.sys, 25 f5.bigip.sys.application, 22 f5.bigip.sys.folder, 23 f5.bigip.sys.stat, 23 f5.bigip.sys.system, 24 f5.common, 34 f5.common.constants, 33 f5.common.iapp_parser, 33 f5.common.logger, 34 43

48 44 Python Module Index

49 Index A Actions (class in f5.bigip.ltm.policy), 14 ActionsCollection (class in f5.bigip.ltm.policy), 14 add_devices() (f5.bigip.cm.cluster.cluster method), 7 add_fdb_entries() (f5.bigip.net.l2gre.l2gre method), 17 add_fdb_entries() (f5.bigip.net.vxlan.vxlan method), 20 add_fdb_entry() (f5.bigip.net.l2gre.l2gre method), 17 add_fdb_entry() (f5.bigip.net.vxlan.vxlan method), 20 add_interface() (f5.bigip.pycontrol.pycontrol.bigip method), 21 add_interfaces() (f5.bigip.pycontrol.pycontrol.bigip method), 21 add_peer() (f5.bigip.cm.cluster.cluster method), 7 add_vlan_to_domain() (f5.bigip.net.route.route method), 18 add_vlan_to_domain_by_id() (f5.bigip.net.route.route method), 18 all_client_profile_names() (f5.bigip.ltm.ssl.ssl method), 16 APLScript (class in f5.bigip.sys.application), 22 APLScriptCollection (class in f5.bigip.sys.application), 22 ApplicationCollection (class in f5.bigip.sys.application), 22 ARP (class in f5.bigip.net.arp), 17 B BigIP (class in f5.bigip), 32 BIGIP (class in f5.bigip.pycontrol.pycontrol), 21 BigIPClusterConfigSaveFailure, 26 BigIPClusterInvalidHA, 26 BigIPClusterPeerAddFailure, 26 BigIPClusterSyncFailure, 26 BigIPDeviceLockAcquireFailed, 26 BigIPException, 26 C certifcate_id (f5.bigip.ltm.ssl.ssl.certificate attribute), 16 certificate_data (f5.bigip.ltm.ssl.ssl.certificate attribute), 16 certificate_from_pem_data() (f5.bigip.ltm.ssl.ssl.certificate method), clear() 16 (f5.bigip.pycontrol.pycontrol.inmemorycache method), 22 client_profile_exits() (f5.bigip.ltm.ssl.ssl method), 16 Cluster (class in f5.bigip.cm.cluster), 7 cluster (f5.bigip.cm.cm attribute), 10 cluster_exists() (f5.bigip.cm.cluster.cluster method), 7 ClusterCreationException, 26 ClusterDeleteException, 26 ClusterQueryException, 26 ClusterUpdateException, 26 CM (class in f5.bigip.cm), 10 Collection (class in f5.bigip.resource), 30 Conditions (class in f5.bigip.ltm.policy), 14 ConditionsCollection (class in f5.bigip.ltm.policy), 14 Containers (f5.bigip.mixins.todictmixin attribute), 29 create() (f5.bigip.cm.cluster.cluster method), 7 create() (f5.bigip.ltm.nat.nat method), 14 create() (f5.bigip.ltm.rule.rule method), 15 create() (f5.bigip.ltm.snat.snat method), 15 create() (f5.bigip.net.arp.arp method), 17 create() (f5.bigip.net.route.route method), 18 create() (f5.bigip.net.selfip.selfip method), 19 create() (f5.bigip.net.vlan.interfaces method), 20 create() (f5.bigip.resource.resource method), 31 create() (f5.bigip.resource.resourcebase method), 31 create_clientssl_profile_for_certificate() (f5.bigip.ltm.ssl.ssl method), 16 create_domain() (f5.bigip.net.route.route method), 18 create_folder() (f5.bigip.sys.system.system method), 24 create_multipoint_profile() method), 17 create_multipoint_profile() method), 20 create_multipoint_tunnel() method), 17 (f5.bigip.net.l2gre.l2gre (f5.bigip.net.vxlan.vxlan (f5.bigip.net.l2gre.l2gre 45

50 create_multipoint_tunnel() (f5.bigip.net.vxlan.vxlan method), 20 create_traffic_group() (f5.bigip.cm.cluster.cluster method), 7 CreateAlreadyExtantResource, 26 crit() (f5.common.logger.log static method), 34 CurlyBraceMismatchException, 33 CustomStat (class in f5.bigip.sys.application), 23 CustomStatCollection (class in f5.bigip.sys.application), 23 D data (f5.bigip.pycontrol.pycontrol.inmemorycache attribute), 22 debug() (f5.common.logger.log static method), 34 decorate_name() (in module f5.bigip.rest_collection), 32 delete() (f5.bigip.cm.cluster.cluster method), 7 delete() (f5.bigip.ltm.rule.rule method), 15 delete() (f5.bigip.net.arp.arp method), 17 delete() (f5.bigip.net.route.route method), 18 delete() (f5.bigip.resource.resource method), 31 delete() (f5.bigip.resource.resourcebase method), 31 delete() (f5.bigip.rest_collection.restinterfacecollection method), 32 delete_all() (f5.bigip.net.arp.arp method), 17 delete_all() (f5.bigip.net.l2gre.l2gre method), 18 delete_all() (f5.bigip.net.route.route method), 18 delete_all() (f5.bigip.net.vxlan.vxlan method), 20 delete_all() (f5.bigip.rest_collection.restinterfacecollection method), 32 delete_all_fdb_entries() (f5.bigip.net.l2gre.l2gre method), 18 delete_all_fdb_entries() (f5.bigip.net.vxlan.vxlan method), 20 delete_by_mac() (f5.bigip.net.arp.arp method), 17 delete_by_subnet() (f5.bigip.net.arp.arp method), 17 delete_domain() (f5.bigip.net.route.route method), 19 delete_fdb_entries() (f5.bigip.net.l2gre.l2gre method), 18 delete_fdb_entries() (f5.bigip.net.vxlan.vxlan method), 20 delete_fdb_entry() (f5.bigip.net.l2gre.l2gre method), 18 delete_fdb_entry() (f5.bigip.net.vxlan.vxlan method), 20 delete_folder() (f5.bigip.sys.system.system method), 24 delete_profile() (f5.bigip.net.l2gre.l2gre method), 18 delete_profile() (f5.bigip.net.vxlan.vxlan method), 20 delete_traffic_group() (f5.bigip.cm.cluster.cluster method), 7 delete_tunnel() (f5.bigip.net.l2gre.l2gre method), 18 delete_tunnel() (f5.bigip.net.vxlan.vxlan method), 20 Device (class in f5.bigip.cm.device), 9 device (f5.bigip.cm.cm attribute), 10 DeviceCreationException, 26 DeviceDeleteException, 26 DeviceProvidesIncompatibleKey, 30 DeviceQueryException, 26 devices() (f5.bigip.cm.cluster.cluster method), 8 DeviceUpdateException, 26 Diameter (class in f5.bigip.ltm.monitor), 10 DiameterCollection (class in f5.bigip.ltm.monitor), 10 disable_auto_sync() (f5.bigip.cm.cluster.cluster method), 8 DNS (class in f5.bigip.ltm.monitor), 10 DNSCollection (class in f5.bigip.ltm.monitor), 10 domain_exists() (f5.bigip.net.route.route method), 19 E EmptyTemplateException, 33 enable_auto_sync() (f5.bigip.cm.cluster.cluster method), 8 error() (f5.common.logger.log static method), 34 ExclusiveAttributesMixin (class in f5.bigip.mixins), 29 exists() (f5.bigip.net.arp.arp method), 17 exists() (f5.bigip.net.route.route method), 19 exists() (f5.bigip.rest_collection.restinterfacecollection method), 32 expiration_date (f5.bigip.ltm.ssl.ssl.certificate attribute), 16 External (class in f5.bigip.ltm.monitor), 10 ExternalCollection (class in f5.bigip.ltm.monitor), 10 F f5 (module), 34 f5.bigip (module), 32 f5.bigip.cm (module), 10 f5.bigip.cm.cluster (module), 7 f5.bigip.cm.device (module), 9 f5.bigip.dynamic_attributes (module), 25 f5.bigip.exceptions (module), 26 f5.bigip.ltm (module), 16 f5.bigip.ltm.monitor (module), 10 f5.bigip.ltm.nat (module), 14 f5.bigip.ltm.policy (module), 14 f5.bigip.ltm.pool (module), 15 f5.bigip.ltm.rule (module), 15 f5.bigip.ltm.snat (module), 15 f5.bigip.ltm.ssl (module), 15 f5.bigip.ltm.virtual (module), 16 f5.bigip.mixins (module), 29 f5.bigip.net (module), 21 f5.bigip.net.arp (module), 17 f5.bigip.net.interface (module), 17 f5.bigip.net.l2gre (module), 17 f5.bigip.net.route (module), 18 f5.bigip.net.selfip (module), 19 f5.bigip.net.vlan (module), Index

51 f5.bigip.net.vxlan (module), 20 f5.bigip.pycontrol (module), 22 f5.bigip.pycontrol.pycontrol (module), 21 f5.bigip.resource (module), 30 f5.bigip.rest_collection (module), 32 f5.bigip.sys (module), 25 f5.bigip.sys.application (module), 22 f5.bigip.sys.folder (module), 23 f5.bigip.sys.stat (module), 23 f5.bigip.sys.system (module), 24 f5.common (module), 34 f5.common.constants (module), 33 f5.common.iapp_parser (module), 33 f5.common.logger (module), 34 F5Error, 22 FirePass (class in f5.bigip.ltm.monitor), 11 FirePassCollection (class in f5.bigip.ltm.monitor), 11 Folder (class in f5.bigip.sys.folder), 23 folder_exists() (f5.bigip.sys.system.system method), 24 FolderCollection (class in f5.bigip.sys.folder), 23 force_root_folder() (f5.bigip.sys.system.system method), 24 force_to_standby() (f5.bigip.sys.system.system method), 24 from_pkcs12_data() (f5.bigip.ltm.ssl.ssl.certificate method), 16 FTP (class in f5.bigip.ltm.monitor), 10 FTPCollection (class in f5.bigip.ltm.monitor), 11 G GateWay_ICMP (class in f5.bigip.ltm.monitor), 11 GateWay_ICMPCollection (class in f5.bigip.ltm.monitor), 11 GenerationMismatch, 30 get() (f5.bigip.pycontrol.pycontrol.inmemorycache method), 22 get_active_connection_count() (f5.bigip.sys.stat.stat method), 23 get_active_modules() (f5.bigip.sys.system.system method), 24 get_active_ssl_tps() (f5.bigip.sys.stat.stat method), 23 get_all_device_names() (f5.bigip.cm.device.device method), 9 get_all_mgmt_addrs() (f5.bigip.cm.device.device method), 9 get_arps() (f5.bigip.net.arp.arp method), 17 get_collection() (f5.bigip.resource.collection method), 30 get_collection() (f5.bigip.resource.organizingcollection method), 30 get_composite_score() (f5.bigip.sys.stat.stat method), 23 get_configsync_addr() (f5.bigip.cm.device.device method), 9 get_cps_health_score() (f5.bigip.sys.stat.stat method), 23 get_cpu_health_score() (f5.bigip.sys.stat.stat method), 23 get_device_group() (f5.bigip.cm.device.device method), 9 get_device_name() (f5.bigip.cm.device.device method), 9 get_domain() (f5.bigip.net.route.route method), 19 get_domain_by_id() (f5.bigip.net.route.route method), 19 get_domain_ids() (f5.bigip.net.route.route method), 19 get_domain_names() (f5.bigip.net.route.route method), 19 get_failover_addrs() (f5.bigip.cm.device.device method), 9 get_failover_state() (f5.bigip.cm.device.device method), 9 get_fdb_entry() (f5.bigip.net.l2gre.l2gre method), 18 get_fdb_entry() (f5.bigip.net.vxlan.vxlan method), 20 get_folders() (f5.bigip.sys.system.system method), 24 get_global_statistics() (f5.bigip.sys.stat.stat method), 23 get_hostname() (f5.bigip.sys.system.system method), 24 get_inbound_throughput() (f5.bigip.sys.stat.stat method), 24 get_interface_macaddresses_dict() (f5.bigip.net.interface.interface method), 17 get_interfaces() (f5.bigip.net.interface.interface method), 17 get_license_operational() (f5.bigip.sys.system.system method), 24 get_local_device_addr() (f5.bigip.cm.cluster.cluster method), 8 get_local_device_name() (f5.bigip.cm.cluster.cluster method), 8 get_lock() (f5.bigip.cm.device.device method), 9 get_mac_addresses() (f5.bigip.net.interface.interface method), 17 get_major_version() (f5.bigip.sys.system.system method), 24 get_mem_health_score() (f5.bigip.sys.stat.stat method), 24 get_metadata() (f5.bigip.cm.cluster.cluster method), 8 get_metadata() (f5.bigip.cm.device.device method), 9 get_mgmt_addr() (f5.bigip.cm.device.device method), 9 get_mgmt_addr_by_device() (f5.bigip.cm.device.device method), 9 get_minor_version() (f5.bigip.sys.system.system method), 24 get_ntp_server() (f5.bigip.sys.system.system method), 24 get_outbound_throughput() (f5.bigip.sys.stat.stat method), 24 get_peer_addr() (f5.bigip.cm.cluster.cluster method), 8 get_pem_certificate() (f5.bigip.ltm.ssl.ssl.certificate method), 16 Index 47

52 get_pem_key() (f5.bigip.ltm.ssl.ssl.certificate method), 16 get_pkcs12() (f5.bigip.ltm.ssl.ssl.certificate method), 16 get_platform() (f5.bigip.sys.system.system method), 25 get_primary_mirror_addr() (f5.bigip.cm.device.device method), 9 get_profiles() (f5.bigip.net.l2gre.l2gre method), 18 get_profiles() (f5.bigip.net.vxlan.vxlan method), 21 get_provision_extramb() (f5.bigip.sys.system.system method), 25 get_secondary_mirror_addr() (f5.bigip.cm.device.device method), 9 IAppQueryException, 26 get_section_end_index() (f5.common.iapp_parser.iappparser method), 33 get_section_start_index() (f5.common.iapp_parser.iappparser method), 33 get_serial_number() (f5.bigip.sys.system.system method), 25 get_sessionid() (f5.bigip.pycontrol.pycontrol.bigip method), 21 get_sync_color() (f5.bigip.cm.cluster.cluster method), 8 get_sync_status() (f5.bigip.cm.cluster.cluster method), 8 get_template_attr() (f5.common.iapp_parser.iappparser method), 33 get_template_name() (f5.common.iapp_parser.iappparser method), 33 get_throughput() (f5.bigip.sys.stat.stat method), 24 get_traffic_groups() (f5.bigip.cm.cluster.cluster method), 8 get_tunnel_by_description() (f5.bigip.net.l2gre.l2gre method), 18 get_tunnel_by_description() (f5.bigip.net.vxlan.vxlan method), 21 get_tunnel_folder() (f5.bigip.net.l2gre.l2gre method), 18 get_tunnel_folder() (f5.bigip.net.vxlan.vxlan method), 21 get_tunnel_key() (f5.bigip.net.l2gre.l2gre method), 18 get_tunnel_key() (f5.bigip.net.vxlan.vxlan method), 21 get_tunnel_sync() (f5.bigip.sys.system.system method), 25 get_tunnels() (f5.bigip.net.l2gre.l2gre method), 18 get_tunnels() (f5.bigip.net.vxlan.vxlan method), 21 get_version() (f5.bigip.sys.system.system method), 25 get_vlans_in_domain() method), 19 get_vlans_in_domain_by_id() method), 19 getf() (f5.bigip.net.route.route (f5.bigip.net.route.route (f5.bigip.pycontrol.pycontrol.inmemorycache method), 22 H HTTP (class in f5.bigip.ltm.monitor), 11 HTTPCollection (class in f5.bigip.ltm.monitor), 11 HTTPS (class in f5.bigip.ltm.monitor), 11 HTTPSCollection (class in f5.bigip.ltm.monitor), 11 HTTPSUnVerifiedCertTransport (class in f5.bigip.pycontrol.pycontrol), 22 I IAppCreationException, 26 IAppDeleteException, 26 IappParser (class in f5.common.iapp_parser), 33 IAppUpdateException, 26 ICMP (class in f5.bigip.ltm.monitor), 11 ICMPCollection (class in f5.bigip.ltm.monitor), 11 icontrol_folder() (in module f5.bigip.rest_collection), 32 icontrol_rest_folder() (in module f5.bigip.rest_collection), 32 id_from_subject_cn() (f5.bigip.ltm.ssl.ssl.certificate method), 16 IMAP (class in f5.bigip.ltm.monitor), 11 IMAPCollection (class in f5.bigip.ltm.monitor), 11 InBand (class in f5.bigip.ltm.monitor), 11 InBandCollection (class in f5.bigip.ltm.monitor), 11 info() (f5.common.logger.log static method), 34 InMemoryCache (class in f5.bigip.pycontrol.pycontrol), 22 Interface (class in f5.bigip.net.interface), 17 InterfaceInstance (class in f5.bigip.pycontrol.pycontrol), 22 InterfaceQueryException, 26 Interfaces (class in f5.bigip.net.vlan), 20 InterfacesCollection (class in f5.bigip.net.vlan), 20 InvalidForceType, 30 InvalidNetworkType, 26 InvalidResource, 30 issuer_cn (f5.bigip.ltm.ssl.ssl.certificate attribute), 16 K key_from_pem_data() (f5.bigip.ltm.ssl.ssl.certificate method), 16 key_length (f5.bigip.ltm.ssl.ssl.certificate attribute), 16 key_passphrase_required (f5.bigip.ltm.ssl.ssl.certificate attribute), 16 KindTypeMismatch, 30 L L2GRE (class in f5.bigip.net.l2gre), 17 L2GRETunnelCreationException, 26 L2GRETunnelDeleteException, 27 L2GRETunnelQueryException, Index