f5.bigip.shared

Module Contents

Submodule List

authn

authz

file_transfer

Classes and functions for configuring BIG-IP

iapp

class f5.bigip.shared.Shared(mgmt)[source]

An organizing collection for Shared resources.

Submodules

authn

class f5.bigip.shared.authn.Authn(shared)[source]
class f5.bigip.shared.authn.Roots(authn)[source]
get_collection(**kwargs)[source]

Get an iterator of Python Resource objects that represent URIs.

The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources 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.

Note

This method implies a single REST transaction with the Collection subclass URI.

Raises:

UnregisteredKind

Returns:

list of reference dicts and Python Resource objects

class f5.bigip.shared.authn.Root(roots)[source]
update(**kwargs)[source]

Update the configuration of the resource on the BIG-IP®.

This method uses HTTP PUT alter the resource state on the BIG-IP®.

The attributes of the instance will be packaged as a dictionary. That dictionary will be updated with kwargs. It is then submitted as JSON to the device.

Various edge cases are handled: * read-only attributes that are unchangeable are removed

Args:
kwargs (dict): Arbitrary number of keyword arguments.

Keys and associated values to alter on the device.

If kwargs has a requests_params key the corresponding dict will be passed to the underlying requests.session.put method where it will be handled according to that API.

load(**kwargs)[source]

Load an already configured service into this instance.

This method uses HTTP GET to obtain a resource from the BIG-IP®.

The URI of the target service is constructed from the instance’s container and **kwargs.

kwargs typically requires the keys name and partition. this may, or may not, be true for a specific service.

Args:
**kwargs (dict): Arbitrary number of keyword arguments.

If kwargs has a requests_params key the corresponding dict will be passed to the underlying requests.session.get method where it will be handled according to that API.

Use the method above to pass query args

Returns:

Resource: A Resource Instance with a populated _meta_data['uri']

modify(**kwargs)[source]

Modify the configuration of the resource on device based on patch

delete(**kwargs)[source]

Delete the resource on the BIG-IP®.

Uses HTTP DELETE to delete the resource on the BIG-IP®.

After this method is called, and status_code 200 response is received instance.__dict__ is replace with {'deleted': True}

Args:
**kwargs (dict): Arbitrary number of keyword arguments.

The only current use is to pass kwargs to the requests API.

If kwargs has a requests_params key the corresponding dict will be passed to the underlying requests.session.delete method where it will be handled according to that API.

Use the method above to pass query args.

authz

class f5.bigip.shared.authz.Authz(shared)[source]
class f5.bigip.shared.authz.Tokens_s(authz)[source]
class f5.bigip.shared.authz.Users_s(authz)[source]
class f5.bigip.shared.authz.Token(tokens)[source]
update(**kwargs)[source]

Update the configuration of the resource on the BIG-IP®.

This method uses HTTP PUT alter the resource state on the BIG-IP®.

The attributes of the instance will be packaged as a dictionary. That dictionary will be updated with kwargs. It is then submitted as JSON to the device.

Various edge cases are handled: * read-only attributes that are unchangeable are removed

Args:
kwargs (dict): Arbitrary number of keyword arguments.

Keys and associated values to alter on the device.

If kwargs has a requests_params key the corresponding dict will be passed to the underlying requests.session.put method where it will be handled according to that API.

modify(**kwargs)[source]

Modify the configuration of the resource on device based on patch

class f5.bigip.shared.authz.User(users)[source]

file_transfer

Classes and functions for configuring BIG-IP

class f5.bigip.shared.file_transfer.File_Transfer(shared)[source]

A PathElement for File_Transfer resources.

class f5.bigip.shared.file_transfer.Uploads(file_transfer)[source]

A file upload resource.

class f5.bigip.shared.file_transfer.Bulk(file_transfer)[source]

A file upload resource.

class f5.bigip.shared.file_transfer.Madm(file_transfer)[source]

A file upload resource.

class f5.bigip.shared.file_transfer.Ucs_Uploads(file_transfer)[source]

A ucs file upload resource

class f5.bigip.shared.file_transfer.Ucs_Downloads(file_transfer)[source]

A ucs file download resource

iapp

class f5.bigip.shared.iapp.Iapp(shared)[source]
class f5.bigip.shared.iapp.Package_Management_Tasks_s(iapp)[source]
class f5.bigip.shared.iapp.Package_Management_Task(package_management_tasks)[source]
create(**kwargs)[source]

Create the resource on the BIG-IP®.

Uses HTTP POST to the collection URI to create a resource associated with a new unique URI on the device.

Args:
**kwargs (dict): Arbitrary number of keyword arguments.

All the key-values needed to create the resource.

If kwargs has a requests_params key the corresponding dict will be passed to the underlying requests.session.post method where it will be handled according to that API.

Returns:
Resource: A python object that represents the object’s configuration

and state on the BIG-IP®.

update(**kwargs)[source]

Update is not supported for ASM Resources

Raises:

UnsupportedOperation: If method is used.