f5 package

• f5.bigip
  • f5.bigip module
    • Organizing Collection Modules
    • Resource Base Classes
    • Resource Exceptions
    • Mixins
  • resource module
  • mixins module
• f5.bigip.cm
  • Module Contents
    • Submodule List
  • Subpackages
  • Submodules
    • device
    • device_group
    • traffic_group
• f5.bigip.tm
  • Subpackage List
  • Subpackages
    • auth
    • cm
    • gtm
    • ltm
    • net
    • shared
    • sys
    • transaction
• f5.bigip.shared
  • Module Contents
    • Submodule List
  • Submodules
    • bigip_failover_state
    • licensing
• f5.multi_device
  • Module contents
    • Submodule List
  • Submodules
    • device_group
    • exceptions
    • trust_domain
    • utils

f5.sdk_exception

A base exception for all exceptions in this library.

Base Exception

F5SDKError(*args, **kwargs)

Import and subclass this exception in all exceptions in this library.

exception f5.sdk_exception.F5SDKError(*args, **kwargs)

Bases: exceptions.Exception

Import and subclass this exception in all exceptions in this library.

exception f5.sdk_exception.AttemptedMutationOfReadOnly(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Read only parameters cannot be set.

exception f5.sdk_exception.BooleansToReduceHaveSameValue(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Dict contains two keys with same boolean value.

exception f5.sdk_exception.DeviceProvidesIncompatibleKey(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise this when server JSON keys are incompatible with Python.

exception f5.sdk_exception.DisallowedCreationParameter(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Exception when partition is passed to create for guest resource.

exception f5.sdk_exception.DisallowedReadParameter(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Exception when partition is passed to load for guest resource.

exception f5.sdk_exception.EmptyContent(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise an error if the returned content size is 0.

exception f5.sdk_exception.ExclusiveAttributesPresent(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raises this when exclusive attributes are present.

exception f5.sdk_exception.FileMustNotHaveDotISOExtension(filename)

Bases: f5.sdk_exception.F5SDKError

Raise this when file has ISO extension.

exception f5.sdk_exception.GenerationMismatch(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

The server reported BIG-IP® is not the expacted value.

exception f5.sdk_exception.ImageFilesMustHaveDotISOExtension(filename)

Bases: f5.sdk_exception.F5SDKError

Raise this when Image files do not have ISO extensions.

exception f5.sdk_exception.InvalidCommand(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise this if command argument supplied is invalid.

exception f5.sdk_exception.InvalidForceType

Bases: exceptions.ValueError

Must be of type bool.

exception f5.sdk_exception.InvalidName

Bases: exceptions.ValueError

Raised during creation when a given resource name is invalid.

exception f5.sdk_exception.InvalidResource(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise this when a caller tries to invoke an unsupported CRUDL op.

All resources support refresh and raw. Only Resource‘s support load, create, update, and delete.

exception f5.sdk_exception.KindTypeMismatch(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise this when server JSON keys are incorrect for the Resource type.

exception f5.sdk_exception.LazyAttributesRequired(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raised when a object accesses a lazy attribute that is not listed.

exception f5.sdk_exception.MemberStateModifyUnsupported(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Modify of node with state=unchecked is unsupported.

exception f5.sdk_exception.MissingHttpHeader(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

We raise this when the expected http header in response is missing.

exception f5.sdk_exception.MissingRequiredCreationParameter(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Various values MUST be provided to create different Resources.

exception f5.sdk_exception.MissingRequiredCommandParameter(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Various values MUST be provided to execute a command.

exception f5.sdk_exception.MissingRequiredReadParameter(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Various values MUST be provided to refresh some Resources.

exception f5.sdk_exception.MissingUpdateParameter(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raises this when update requires specific parameters together.

exception f5.sdk_exception.NodeStateModifyUnsupported(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Modify of node with state=unchecked is unsupported.

exception f5.sdk_exception.NonExtantApplication(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise if the dos profile application sub-collection

resource does not exist on the device.

exception f5.sdk_exception.NonExtantPolicyRule(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise if a rule does not exist on the device.

exception f5.sdk_exception.NonExtantFirewallRule(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise if the policy does not exist on the device.

exception f5.sdk_exception.NonExtantVirtualPolicy(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise if the policy does not exist on the device.

exception f5.sdk_exception.OperationNotSupportedOnPublishedPolicy(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise if update/modify attempted on published policy.

exception f5.sdk_exception.RequestParamKwargCollision(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise where requests parameter collides

with a method parameter of the same name.

exception f5.sdk_exception.TagModeDisallowedForTMOSVersion(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise if tagmode is not supported for given TMOS version.

exception f5.sdk_exception.TransactionSubmitException(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise this when Transaction commit fails.

exception f5.sdk_exception.URICreationCollision(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

self._meta_data[‘uri’] can only be assigned once. In create or load.

exception f5.sdk_exception.UnregisteredKind(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

The returned server JSON kind key wasn’t expected by this Resource.

exception f5.sdk_exception.UnsupportedMethod(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise this if a method supplied is unsupported.

exception f5.sdk_exception.UnsupportedTmosVersion(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise the error if a class of an API is instantiated,

on a TMOS version where API was not yet implemented/supported.

exception f5.sdk_exception.UnsupportedOperation(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Object does not support the method that was called.

exception f5.sdk_exception.UtilError(*args, **kwargs)

Bases: f5.sdk_exception.F5SDKError

Raise this if command excecution returns an error.

exception f5.sdk_exception.RequiredOneOf(required_one_of)

Bases: f5.sdk_exception.F5SDKError

Raise this if more than one of required argument sets is provided.