F5 Python SDK Documentation
Introduction
This project implements an object model based SDK for the F5 Networks® BIG-IP® iControl® REST interface. Users of this library can create, edit, update, and delete configuration objects on a BIG-IP®. For more information on the basic principals that the SDK uses, see the User Guide.
Quick Start
Installation
$ pip install f5-sdk
Basic Example
from f5.bigip import ManagementRoot
# Connect to the BigIP
mgmt = ManagementRoot("bigip.example.com", "admin", "somepassword")
# Get a list of all pools on the BigIP and print their names and their
# members' names
pools = mgmt.tm.ltm.pools.get_collection()
for pool in pools:
print pool.name
for member in pool.members_s.get_collection():
print member.name
# Create a new pool on the BIG-IP
mypool = mgmt.tm.ltm.pools.pool.create(name='mypool', partition='Common')
# Load an existing pool and update its description
pool_a = mgmt.tm.ltm.pools.pool.load(name='mypool', partition='Common')
pool_a.description = "New description"
pool_a.update()
# Delete a pool if it exists
if mgmt.tm.ltm.pools.pool.exists(name='mypool', partition='Common'):
pool_b = mgmt.tm.ltm.pools.pool.load(name='mypool', partition='Common')
pool_b.delete()
Detailed Documentation
- User Guide
- Developer Guide
- F5 SDK API Docs
- f5 package
- f5.bigip
- f5.bigip.cm
- f5.bigip.tm
- f5.bigip.shared
- f5.multi_device
- Module contents
- Submodules
- device_group
- exceptions
ClusterError
DeviceGroupError
TrustDomainError
AlreadyManagingCluster
ClusterNotSupported
ClusterOperationNotSupported
DeviceAlreadyInTrustDomain
MissingRequiredDeviceGroupParameter
NoClusterToManage
DeviceGroupNotSupported
DeviceGroupOperationNotSupported
DeviceNotTrusted
TrusteeNotInTrustDomain
UnexpectedDeviceGroupState
UnexpectedDeviceGroupDevices
UnexpectedDeviceGroupType
- trust_domain
- utils
- f5.sdk_exception
- Base Exception
F5SDKError
AttemptedMutationOfReadOnly
BooleansToReduceHaveSameValue
DeviceProvidesIncompatibleKey
DisallowedCreationParameter
DisallowedReadParameter
EmptyContent
ExclusiveAttributesPresent
FileMustNotHaveDotISOExtension
GenerationMismatch
ImageFilesMustHaveDotISOExtension
InvalidCommand
InvalidForceType
InvalidName
InvalidResource
KindTypeMismatch
LazyAttributesRequired
MemberStateModifyUnsupported
MissingHttpHeader
MissingRequiredCreationParameter
MissingRequiredCommandParameter
MissingRequiredReadParameter
MissingRequiredRequestsParameter
MissingUpdateParameter
NodeStateModifyUnsupported
NonExtantApplication
NonExtantPolicyRule
NonExtantFirewallRule
NonExtantVirtualPolicy
OperationNotSupportedOnPublishedPolicy
RequestParamKwargCollision
TagModeDisallowedForTMOSVersion
TransactionSubmitException
URICreationCollision
UnregisteredKind
UnsupportedMethod
UnsupportedTmosVersion
UnsupportedOperation
UtilError
DraftPolicyNotSupportedInTMOSVersion
ConstraintError
RequiredOneOf
TimeoutError
- Base Exception
- f5 package
Copyright
Copyright 2014-2016 F5 Networks Inc.
License
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
http://www.apache.org/licenses/LICENSE-2.0
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.
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.