f5sdk.bigip.dns package¶
Python module for BIG-IP DNS
Example - Basic:
from f5sdk.bigip import ManagementClient
from f5sdk.bigip.dns import DataCentersClient
from f5sdk.bigip.dns import ServersClient
from f5sdk.bigip.dns import PoolsClient
device = ManagementClient('192.0.2.10', user='admin', password='admin')
datacenters_client = DataCentersClient(device)
servers_client = ServersClient(device)
pools_client = PoolsClient(device)
# create/list/update/delete various record types
pools_client = PoolsClient(device, record_tye='a')
# list
datacenters_client.list()
servers_client.list()
pools_client.list()
# create
datacenters_client.create(
config={
'name': 'my_datacenter'
}
)
servers_client.create(
config={
'name': 'my_server'
}
)
pools_client.create(
config={
'name': 'my_pool'
}
)
# show
datacenters_client.show(name='my_datacenter')
servers_client.show(name='my_server')
pools_client.show(name='my_pool')
# update dns datacenter
datacenters_client.update(
name='my_offering_id',
config={
'regkey': 'my_reg_key'
}
)
# update server
servers_client.update(
name='my_server',
config={
'description': 'added description'
}
)
# update pool
pools_client.update(
name='my_pool',
config={
'description': 'added description'
}
)
# delete
datacenters_client.delete(name='my_datacenter')
servers_client.delete(name='my_server')
pools_client.delete(name='my_pool')
-
class
f5sdk.bigip.dns.DataCentersClient(client, **kwargs)¶ BIG-IP DNS datacenters client
-
list()¶ Refer to method documentation
-
create()¶ Refer to method documentation
-
show()¶ Refer to method documentation
-
update()¶ Refer to method documentation
-
delete()¶ Refer to method documentation
-
create(**kwargs) Create operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
delete(**kwargs) Delete operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
list(**kwargs) List operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
query_parameters (dict) – Query parameters for the request
- Returns
the serialized REST response
- Return type
dict
-
show(**kwargs) Show operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
update(**kwargs) Update operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
-
class
f5sdk.bigip.dns.ServersClient(client, **kwargs)¶ BIG-IP servers management client
-
list()¶ Refer to method documentation
-
create()¶ Refer to method documentation
-
show()¶ Refer to method documentation
-
update()¶ Refer to method documentation
-
delete()¶ Refer to method documentation
-
create(**kwargs) Create operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
delete(**kwargs) Delete operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
list(**kwargs) List operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
query_parameters (dict) – Query parameters for the request
- Returns
the serialized REST response
- Return type
dict
-
show(**kwargs) Show operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
update(**kwargs) Update operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
-
class
f5sdk.bigip.dns.PoolsClient(client, **kwargs)¶ BIG-IP DNS pools client
-
list()¶ Refer to method documentation
-
create()¶ Refer to method documentation
-
show()¶ Refer to method documentation
-
update()¶ Refer to method documentation
-
delete()¶ Refer to method documentation
-
create(**kwargs) Create operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
delete(**kwargs) Delete operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
list(**kwargs) List operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
query_parameters (dict) – Query parameters for the request
- Returns
the serialized REST response
- Return type
dict
-
show(**kwargs) Show operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-
update(**kwargs) Update operation
- Parameters
**kwargs – optional keyword arguments
- Keyword Arguments
name (str) – name (id) of the object to operate against
config (dict) – object containing configuration
config_file (str) – reference to a local file containing configuration
- Returns
the serialized REST response
- Return type
dict
-