Skip to content

Penggunaan Dasar F5 iControl API

F5 iControl adalah REST API bawaan F5 BIG-IP. Secara default, F5 iControl akan selalu dalam kondisi aktif. F5 iControl API memberikan metode untuk melakukan otomatisasi ketika ada manual work yang dikerjakan berulang-ulang.

Penggunaan

Otentikasi

F5 iControl memiliki 2 metode otentikasi:

  • Basic Authentication
  • Token Authentication

Catatan

Basic Authentication tidak tersedia pada user BIG-IP yang terhubung dengan external authentication seperti LDAP atau Active Directory (AD).

Basic Authentication merupakan metode paling sederhana untuk melakukan otentikasi ke perangkat F5 BIG-IP.

Untuk menggunakan Basic Authentication menggunakan cURL, gunakan perintah berikut:

curl -s \                           # (1)!
    -k \                            # (2)!
    -u "<username>:<password>" \    # (3)!
    https://<IP F5>/<endpoint>      # (4)!
  1. -s (--silent)
    Digunakan untuk mengurangi noise pada output cURL.
  2. -k (--insecure)
    Digunakan untuk mengabaikan TLS self-signed signature yang umum digunakan pada customer.
  3. -u (--username)
    Digunakan untuk melakukan Basic Authentication.
    Apabila password memiliki special character, password dapat dikosongkan agar cURL akan meminta password secara interaktif.
  4. Alamat domain yang dituju beserta dengan endpoint yang akan diakses.

Contoh: 

curl -sku admin:password https://10.2.3.4/mgmt/tm/ltm

Token Authentication lebih aman dibandingkan Basic Authentication karena password tidak akan tercatat pada history shell (.bash_history). Namun, metode Token Authentication membutuhkan satu langkah tambahan sebelum melakukan request, yaitu dengan mendapatkan token authentication terlebih dahulu.

Langkah 1: Mendapatkan Token (Login)

Sebelum melakukan aktivitas pada BIG-IP, otentikasi perlu dilakukan terlebih dahulu untuk mendapatkan token. Gunakan command berikut:

curl -sk https://<BIG IP address>/mgmt/shared/authn/login    \ # (1)!
    -d '{"username": "<username>","password": "<password>"}' \ # (2)!
    | jq                                                     \ # (3)!
  1. Path yang digunakan untuk melakukan otentikasi.
  2. Parameter body yang digunakan untuk melakukan otentikasi. Sesuaikan dengan kredensial user BIG-IP yang valid.
  3. jq digunakan untuk memformat output JSON agar lebih mudah dibaca.

Apabila request berhasil, BIG-IP akan memberikan response seperti berikut:

{
  "username": "<username>", // (1)!
  "loginReference": {
    "link": "https://localhost/mgmt/cm/system/authn/providers/local/login"
  },
  "loginProviderName": "local",
  "token": {
    "token": "<token>", // (2)!
    "name": "<token>",
    "userName": "<username>",
    "authProviderName": "local",
    "user": {
      "link": "https://localhost/mgmt/shared/authz/users/<username>"
    },
    "groupReferences": [],
    "timeout": 1200, // (3)!
    "startTime": "2026-08-06T20:05:44.289+0700",
    "address": "<ip>",
    "partition": "[All]",
    "generation": 1,
    "lastUpdateMicros": 1786021544289116,
    "expirationMicros": 1786022744289000,
    "kind": "shared:authz:tokens:authtokenitemstate",
    "selfLink": "https://localhost/mgmt/shared/authz/tokens/<token>"
  },
  "generation": 0,
  "lastUpdateMicros": 0
}
  1. username
    Username yang digunakan untuk login.
  2. token
    String token unik yang dibutuhkan untuk request selanjutnya. Salin token ini.
  3. timeout
    Waktu token, yang menunjukkan kapan token ini expire dalam hitungan detik (s).
    Waktu ini bersifat absolute, bukan idle, sehingga token akan expire dalam waktu 1200 detik walau masih digunakan.

Langkah 2: Menggunakan Token

Untuk menggunakan Token yang sudah dibuat sebelumnya, Token perlu dicantumkan sebagai header "X-F5-Auth-Token". Contoh:

curl -sk https://<IP address>/mgmt/tm/ltm \
    -H "X-F5-Auth-Token <Token>" # (1)!
  1. --header (-H)
    Header yang dikirimkan sebagai request.