f5.bigip.tm.net
Module contents
BIG-IP® net module
- REST URI
http://localhost/mgmt/tm/net/
- GUI Path
Network
- REST Kind
tm:net:*
Submodule List
BIG-IP® Network ARP module. |
|
BIG-IP® Network ARP module. |
|
Directory: net module: fdb. |
|
BIG-IP® Network interface module. |
|
BIG-IP® Network route module. |
|
Directory: net module: route-domain. |
|
BIG-IP® Network self-ip module. |
|
BIG-IP® Network trunk module. |
|
BIG-IP® Network tunnels module. |
|
BIG-IP® Network vlan module. |
Submodules
arp
BIG-IP® Network ARP module.
- REST URI
http://localhost/mgmt/tm/net/arp
- GUI Path
Network --> ARP
- REST Kind
tm:net:arp:*
dns_resolver
BIG-IP® Network ARP module.
- REST URI
http://localhost/mgmt/tm/net/dns-resolver
- GUI Path
Network --> Dns Resolvers
- REST Kind
tm:net:dns:*
fdb
Directory: net module: fdb.
- REST URI
https://localhost/mgmt/tm/net/fdb
- GUI Path
XXX
- REST Kind
tm:net:fdb:*
interface
BIG-IP® Network interface module.
- REST URI
http://localhost/mgmt/tm/net/interface
- GUI Path
Network --> Interfaces
- REST Kind
tm:net:interface:*
route
BIG-IP® Network route module.
- REST URI
http://localhost/mgmt/tm/net/route
- GUI Path
Network --> Routes
- REST Kind
tm:net:route:*
- class f5.bigip.tm.net.route.Route(route_s)[source]
BIG-IP® network route resource
- create(**kwargs)[source]
Create a Route on the BIG-IP® and the associated python object.
One of the following gateways is required when creating the route objects:
blackhole
,gw
,tmInterface
,pool
.- Params kwargs:
keyword arguments passed in from create call
- Raises:
KindTypeMismatch
- Raises:
MissingRequiredCreationParameter
- Raises:
HTTPError
- Returns:
Python Route object
route_domain
Directory: net module: route-domain.
- REST URI
https://localhost/mgmt/tm/net/route-domain?ver=11.6.0
- GUI Path
XXX
- REST Kind
tm:net:route-domain:*
selfip
BIG-IP® Network self-ip module.
Note
Self IPs path does not match their kind or URI because the string self
causes problems in Python because it is a reserved word.
- REST URI
http://localhost/mgmt/tm/net/self
- GUI Path
Network --> Self IPs
- REST Kind
tm:net:self:*
- class f5.bigip.tm.net.selfip.Selfips(net)[source]
BIG-IP® network Self-IP collection
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.
- class f5.bigip.tm.net.selfip.Selfip(selfip_s)[source]
BIG-IP® Self-IP resource
Use this object to create, refresh, update, delete, and load self ip configuration on the BIG-IP®. 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
192.168.1.1/32
.Note
The object is actually called
self
in iControlREST, but obviously this will cause problems in Python so we changed its name toSelfip
.
trunk
BIG-IP® Network trunk module.
- REST URI
http://localhost/mgmt/tm/net/trunk
- GUI Path
Network --> Trunks
- REST Kind
tm:net:trunk:*
tunnels
BIG-IP® Network tunnels module.
- REST URI
http://localhost/mgmt/tm/net/tunnels
- GUI Path
Network --> tunnels
- REST Kind
tm:net:tunnels:*
vlan
BIG-IP® Network vlan module.
- REST URI
http://localhost/mgmt/tm/net/vlan
- GUI Path
Network --> Vlans
- REST Kind
tm:net:vlan:*
- class f5.bigip.tm.net.vlan.Interfaces_s(vlan)[source]
BIG-IP® network Vlan interface collection.
Note
Not to be confused with
tm/mgmt/net/interface
. This is object is actually calledinterfaces
with ans
by the BIG-IP’s REST API.
- class f5.bigip.tm.net.vlan.Interfaces(interfaces_s)[source]
BIG-IP® network Vlan interface resource.
- 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.
As tagMode parameter will be required only if tagged is set to ‘True’ we have to use conditional to capture this logic during create.
- 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 underlyingrequests.session.put
method where it will be handled according to that API.