icontrol package Submodules icontrol Sample Clauses

icontrol package Submodules icontrol session module‌‌‌‌‌ A BigIP-RESTServer URI handler. REST-APIs use it on the requests library. Use this module to make calls to a BigIP-REST server. It will handle:

icontrol package Submodules icontrol authtoken module‌‌‌‌‌ A requests-compatible system for BIG-IP token-based authentication. BIG-IP only allows users with the Administrator role to authenticate to iControl using HTTP Basic auth. Non- Administrator users can use the token-based authentication scheme described at: xxxxx://xxxxxxxxxx.x0.xxx/wiki/xxxxxxxx.xxxxxxxxxxxxxx_with_the_f5_rest_api.ashx Use this module with requests to automatically get a new token, and attach requests.Session object, so that it is used to authenticate future requests. Instead of using this module directly, it is easiest to enable it by passing a token=True argument when creating the iControlRESTSession: >>> iCRS = iControlRESTSession('bob', 'secret', token=True) class icontrol.authtoken.iControlRESTTokenAuth(username, password, lo- gin_provider_name=’tmos’) Bases: requests.auth.AuthBase Acquire and renew BigIP iControl REST authentication tokens. Parameters • username (str) – The username on BigIP • password (str) – The password for username on BigIP • login_provider_name (str) – The name of the login provider that BigIP should consult when creating the token. If username is configured locally on the BigIP, login_provider_name should be "tmos" (default). Otherwise (for example, username is configured on LDAP that BigIP consults), consult BigIP documentation or your system administrator for the value of login_provider_name. get_new_token(netloc) Get a new token from BIG-IP and store it internally. Throws relevant exception if it fails to get a new token. This method will be called automatically if a request is attempted but there is no authentication token, or the authentication token is expired. It is usually not necessary for users to call it, but it can be called if it is known that the authentication token has been invalidated by other means.