Troubleshooting

Below are Troubleshooting steps that can be used while working with the F5 SDK Python.

Enable Debugging

Debugging can be enabled by setting the following environment variable prior to using the SDK.

export F5_SDK_LOG_LEVEL='DEBUG'

Disable SSL/TLS Certificate Verification

To disable SSL/TLS certificate verification, set the following environment variable prior to using the SDK.

export F5_DISABLE_CERT_VERIFY='true'

Note

This is not recommended for production use, please configure the BIG-IP with a valid certificate.

Alternate Management Port

To connect to a BIG-IP using a non-default management port, such as 8443, it should be provided during management client instantiation.

device = ManagementClient('192.0.2.10', user='admin', password='admin', port=8443)

Note

The BIG-IP management client will attempt to discover the management port using the order 443 > 8443 > 443 (fallback). However this may result in an unwanted delay for BIG-IPs using 8443 as a management port.

Error Messages

Below is a list of common error messages and their meaning.

  • AuthRequiredError: This error is raised when authentication is required.

  • InputRequiredError: This error is raised if input is required.

  • InvalidComponentError: This error is raised if an invalid component is provided.

  • InvalidComponentVersionError: This error is raised if an invalid component version is provided.

  • HTTPError: This error is raised during login if there was an HTTP communication error while communicating with the host.

  • FileLoadError: This error is raised if file load error occurs.

  • SSHCommandStdError: This error is raised if the ssh client command response contains stderr.

  • DeviceReadyError: This error is raised if the device ready check fails.

  • InvalidAuthError: This error is raised if authentication fails.


Note

The F5 SDK-Python is currently in early development and we want to hear from you! To provide feedback on F5 SDK-Python or this documentation, you can file a GitHub Issue.