Test connectivity to F5 iControl REST API with F5 MP for vROps
Article ID: 334220
Updated On:
Products
Issue/Introduction
The vRealize Operations Management Pack for F5 BIG-IP makes a connection to the monitored BIG-IP system’s iControl REST API. The iControl API is supported by F5 on versions 11.5 and higher of BIG-IP. During deployment of the Management Pack, if the test connection fails or other collection errors occur, could be caused by an inaccessible API. Perform the following actions to validate connectivity to the API and status of the iControl REST daemon.
One simple way to access the iControl API is with the use of curl. Run the following statement on a linux host with connectivity to the BIG-IP system, replacing the user, password and IP or hostname values. If the user or password are entered incorrectly, expect the return to include, “This server could not verify that you are authorized to access”.
$ curl -sk -u admin:password https://<hostname>/mgmt/tm/sys/version
The following is an example output of a successful command. To make the output more human readable, I have set the output to json format.
$ curl -sk -u admin:admin https://10.66.8.243/mgmt/tm/sys/version | python -m json.tool
{
"entries": {
"https://localhost/mgmt/tm/sys/version/0": {
"nestedStats": {
"entries": {
"Build": {
"description": "0.0.401"
},
"Date": {
"description": "Mon Aug 11 21:08:03 PDT 2014"
},
"Edition": {
"description": "Final"
},
"Product": {
"description": "BIG-IP"
},
"Title": {
"description": "Main Package"
},
"Version": {
"description": "11.6.0"
}
}
}
}
},
"kind": "tm:sys:version:versionstats",
"selfLink": "https://localhost/mgmt/tm/sys/version?ver=11.6.0""
Assuming the curl command processes correctly, some other quick calls that may be helpful include the following.
To verify system hardware type, such as Virtual Edition, Hardware Device, or vCMP:
$ curl -sk -u admin:admin https://<hostname>/mgmt/tm/sys/hardware
To collect general global settings of the BIG-IP system:
$ curl -sk -u admin:admin https://<hostname>/mgmt/tm/sys/global-settings
When the curl commands are not completing or receiving connection refused messages, it may be possible that the iControl service (daemon) has not been started.
Run the following command from the BIG-IP system to show the running status for the iControl REST Daemon (icrd):
# tmsh show sys service icrd
To start or restart the daemon, run the following commands:
# tmsh stop sys service icrd
# tmsh start sys service icrd
Additional information on BIG-IP daemons can be found here:
https://support.f5.com/kb/en-us/solutions/public/13000/400/sol13444.html
Environment
Feedback
