Back to top

iControl REST API

This documentes a portion of the 11.5 version of the iControl REST API.

NOTE: This document is a work in progress.

Module URI

https://management-ip/mgmt/tm/module

This URI accesses all of the sub-modules and/or components under the given module. The management-ip is the BIG-IP device that answers this REST query. For example, you could use the following URI (on a particular BIG-IPserver) to access all of the components and sub-modules under the ltm module: https://192.168.25.42/mgmt/tm/ltm

Sub-module URI

https://management-ip/mgmt/tm/module/sub-module

This accesses all of the sub-modules and/or components under the given sub-module.

Component URI

https://management-ip/mgmt/tm/module[/sub-module]/component

This accesses details about the given component. TheTraffic Management Shell (tmsh) Reference documents the hierarchy of modules and components, and identifies details of each component

Currently supported components

  • apm
  • cm
  • gtm
  • ltm
  • net
  • sys

CM 

CM Collection State 

Retrieve all CM States
/mgmt/tm/cm?ver=11.5.0

Retrieves all cm sub-modules

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "items": [
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/cm/cert?ver=11.5.1"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/cm/device?ver=11.5.1"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/cm/device-group?ver=11.5.1"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/cm/key?ver=11.5.1"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/cm/traffic-group?ver=11.5.1"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/cm/trust-domain?ver=11.5.1"
      }
    }
  ],
  "selfLink": "https://localhost/mgmt/tm/cm?ver=11.5.1",
  "kind": "tm:cm:cmcollectionstate"
}

Device 

Device Collection State 

Retrieve all Device States
/mgmt/tm/cm/device?ver=11.5.0

Retrieves all devices.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "items": [
    {
      "unicastAddress": [
        {
          "port": 1026,
          "ip": "185.200.201.35",
          "effectivePort": 1026,
          "effectiveIp": "185.200.201.35"
        },
        {
          "port": 1026,
          "ip": "185.200.201.6",
          "effectivePort": 1026,
          "effectiveIp": "185.200.201.6"
        }
      ],
      "version": "11.5.1",
      "timeZone": "PDT",
      "selfDevice": "false",
      "product": "BIG-IP",
      "platformId": "Z100",
      "optionalModules": [
        "AFM, VE",
        "APM, Base, VE",
        "APM, Max CCU, VE",
        "App Mode (TMSH Only, No Root/Bash)",
        "ASM, VE",
        "Best Bundle, 5Gbps",
        "DNS and GTM (1K QPS), VE",
        "DNS and GTM (250 QPS), VE",
        "DNS Services, VE",
        "External Interface and Network HSM, VE",
        "GTM, VE",
        "IPI Subscription, 1Yr, VE",
        "IPI Subscription, 3Yr, VE",
        "Max Compression, VE",
        "MSM",
        "PEM, Quota Management, VE",
        "PEM, VE",
        "PSM, VE",
        "Routing Bundle, VE",
        "SDN Services, VE",
        "SSL, Forward Proxy, VE",
        "SWG Subscription, 1Yr, VE",
        "SWG Subscription, 3Yr, VE",
        "URL Filtering Subscription, 1Yr, VE",
        "URL Filtering Subscription, 3Yr, VE"
      ],
      "multicastPort": 0,
      "multicastIp": "any6",
      "mirrorSecondaryIp": "any6",
      "mirrorIp": "185.200.201.35",
      "marketingName": "BIG-IP Virtual Edition",
      "managementIp": "185.200.201.6",
      "baseMac": "00:50:56:a4:2b:fb",
      "activeModules": [
        "Better Bundle, 5Gbps|DOHNPVJ-XGIITUY|AFM, VE|SDN Services, VE|DNS-GTM, Base, 5Gbps|Acceleration Manager, VE|GTM Licensed Objects, Unlimited|DNS Licensed Objects, Unlimited|Routing Bundle, VE|DNS Rate Fallback, 250K|GTM Rate Fallback, 250K|GTM Rate, 250K|DNS Rate Limit, 250K QPS|PSM, VE",
        "LTM, 5 Gbps, VE|AVQHZYS-HNTKLCS|IPV6 Gateway|Rate Shaping|Ram Cache|50 MBPS COMPRESSION|SSL, 500 TPS Per Core|SSL, Max TPS, VE|Anti-Virus Checks|Base Endpoint Security Checks|Firewall Checks|Network Access|Secure Virtual Keyboard|APM, Web Application|Machine Certificate Checks|Protected Workspace|Remote Desktop|App Tunnel|Routing Bundle, VE|PSM, VE|GTM Licensed Objects, Unlimited|DNS Licensed Objects, Unlimited|DNS Rate Fallback, 250K|GTM Rate Fallback, 250K|GTM Rate, 250K|DNS Rate Limit, 250K QPS"
      ],
      "selfLink": "https://localhost/mgmt/tm/cm/device/~Common~device1?ver=11.5.1",
      "generation": 1,
      "fullPath": "/Common/device1",
      "partition": "Common",
      "name": "device1",
      "kind": "tm:cm:device:devicestate",
      "build": "0.0.110",
      "chassisId": "4224d2de-368e-49a4-31a98e3935c5",
      "chassisType": "individual",
      "configsyncIp": "185.200.201.35",
      "edition": "Final",
      "failoverState": "active",
      "haCapacity": 0,
      "hostname": "device1"
    },
    {
      "unicastAddress": [
        {
          "port": 1026,
          "ip": "185.200.201.7",
          "effectivePort": 1026,
          "effectiveIp": "185.200.201.7"
        },
        {
          "port": 1026,
          "ip": "185.200.201.36",
          "effectivePort": 1026,
          "effectiveIp": "185.200.201.36"
        }
      ],
      "version": "11.5.1",
      "timeZone": "PDT",
      "selfDevice": "true",
      "product": "BIG-IP",
      "platformId": "Z100",
      "optionalModules": [
        "AFM, VE",
        "APM, Base, VE",
        "APM, Max CCU, VE",
        "App Mode (TMSH Only, No Root/Bash)",
        "ASM, VE",
        "Best Bundle, 5Gbps",
        "DNS and GTM (1K QPS), VE",
        "DNS and GTM (250 QPS), VE",
        "DNS Services, VE",
        "External Interface and Network HSM, VE",
        "GTM, VE",
        "IPI Subscription, 1Yr, VE",
        "IPI Subscription, 3Yr, VE",
        "Max Compression, VE",
        "MSM",
        "PEM, Quota Management, VE",
        "PEM, VE",
        "PSM, VE",
        "Routing Bundle, VE",
        "SDN Services, VE",
        "SSL, Forward Proxy, VE",
        "SWG Subscription, 1Yr, VE",
        "SWG Subscription, 3Yr, VE",
        "URL Filtering Subscription, 1Yr, VE",
        "URL Filtering Subscription, 3Yr, VE"
      ],
      "multicastPort": 0,
      "multicastIp": "any6",
      "mirrorSecondaryIp": "any6",
      "mirrorIp": "185.200.201.36",
      "marketingName": "BIG-IP Virtual Edition",
      "managementIp": "185.200.201.7",
      "key": "/Common/dtdi.key",
      "hostname": "device2",
      "baseMac": "00:50:56:a4:2c:00",
      "activeModules": [
        "Better Bundle, 5Gbps|HSTWFWX-GRGUNXA|AFM, VE|SDN Services, VE|DNS-GTM, Base, 5Gbps|Acceleration Manager, VE|GTM Licensed Objects, Unlimited|DNS Licensed Objects, Unlimited|Routing Bundle, VE|DNS Rate Fallback, 250K|GTM Rate Fallback, 250K|GTM Rate, 250K|DNS Rate Limit, 250K QPS|PSM, VE",
        "LTM, 5 Gbps, VE|NSSWLJQ-GQGRKLU|IPV6 Gateway|Rate Shaping|Ram Cache|50 MBPS COMPRESSION|SSL, 500 TPS Per Core|SSL, Max TPS, VE|Anti-Virus Checks|Base Endpoint Security Checks|Firewall Checks|Network Access|Secure Virtual Keyboard|APM, Web Application|Machine Certificate Checks|Protected Workspace|Remote Desktop|App Tunnel|Routing Bundle, VE|PSM, VE|GTM Licensed Objects, Unlimited|DNS Licensed Objects, Unlimited|DNS Rate Fallback, 250K|GTM Rate Fallback, 250K|GTM Rate, 250K|DNS Rate Limit, 250K QPS"
      ],
      "selfLink": "https://localhost/mgmt/tm/cm/device/~Common~device2?ver=11.5.1",
      "generation": 1,
      "fullPath": "/Common/device2",
      "partition": "Common",
      "name": "device2",
      "kind": "tm:cm:device:devicestate",
      "build": "4.0.128",
      "cert": "/Common/dtdi.crt",
      "chassisId": "42242cff-5823-b216-49d22f5ba54d",
      "chassisType": "individual",
      "configsyncIp": "185.200.201.36",
      "edition": "Hotfix HF4",
      "failoverState": "standby",
      "haCapacity": 0
    }
  ],
  "selfLink": "https://localhost/mgmt/tm/cm/device?ver=11.5.1",
  "kind": "tm:cm:device:devicecollectionstate"
}

LTM 

LTM Collection State 

Retrieve all LTM States
/mgmt/tm/ltm?ver=11.5.0

Retrieves all ltm module components

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "items": [
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/auth?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/data-group?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/dns?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/global-settings?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/html-rule?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/message-routing?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/monitor?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/persistence?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/profile?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/default-node-monitor?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/ifile?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/nat?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/node?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/policy?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/policy-strategy?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/pool?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/rule?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/snat?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/snat-translation?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/snatpool?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/traffic-class?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/virtual?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/ltm/virtual-address?ver=11.5.0"
      }
    }
  ],
  "selfLink": "https://localhost/mgmt/tm/ltm?ver=11.5.0",
  "kind": "tm:ltm:ltmcollectionstate"
}

Virtual 

This section groups iControl virtual resources.

Virtual State 

A Virtual is the other central object utilized by the App.net Stream API. It has rich text and annotations which comprise all of the content a users sees in their feed. Virtuals are closely tied to the follow graph…

Modify a Virtual
/mgmt/tm/ltm/virtual/{name}?ver=11.5.0{?expandSubcollections}

Modifies the virtual server.

  • Parameters
  • name
    string (required) Example: test_vs

    The name of the virtual server.

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {
    "profiles": [
        "http",
        "my_ssl"
    ],
    "persist": "cookie",
    "fallbackPersistence" "source_addr"
}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "profilesReference": {
        "items": [
          {
              "context": "all",
              "selfLink": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles/~Common~http?ver=11.5.0",
              "generation": 1210128,
              "fullPath": "/Common/http",
              "partition": "Common",
              "name": "http",
              "kind": "tm:ltm:virtual:profiles:profilesstate"
          },
          {
              "context": "all",
              "selfLink": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles/~Common~tcp?ver=11.5.0",
              "generation": 1210128,
              "fullPath": "/Common/tcp",
              "partition": "Common",
              "name": "tcp",
              "kind": "tm:ltm:virtual:profiles:profilesstate"
          }
        ],
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles?ver=11.5.0"
    },
    "policiesReference": {
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/policies?ver=11.5.0"
    },
    "fwRulesReference": {
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/fw-rules?ver=11.5.0"
    },
    "vsIndex": 161045,
    "rules": [
        "/Common/test_rule",
        "/Common/test_rule2"
    ],
    "vlansDisabled": null,
    "translatePort": "enabled",
    "translateAddress": "enabled",
    "synCookieStatus": "not-activated",
    "sourcePort": "preserve",
    "sourceAddressTranslation": {},
    "source": "0.0.0.0/0",
    "rateLimitSrcMask": 0,
    "rateLimitMode": "object",
    "rateLimitDstMask": 0,
    "rateLimit": "disabled",
    "pool": "/Common/test_pool",
    "connectionLimit": 0,
    "cmpEnabled": "yes",
    "autoLasthop": "default",
    "selfLink": "https://localhost/mgmt/tm/ltm/virtual/test_vs?expandSubcollections=true&ver=11.5.0",
    "generation": 1210128,
    "fullPath": "test_vs",
    "name": "test_vs",
    "kind": "tm:ltm:virtual:virtualstate",
    "destination": "/Common/8.8.8.8:80",
    "enabled": null,
    "gtmScore": 0,
    "ipProtocol": "tcp",
    "mask": "255.255.255.255",
    "mirror": "disabled",
    "mobileAppTunnel": "disabled",
    "nat64": "disabled",
    "fallbackPersistence": "/Common/source_addr",
    "persist": [
        {
            "tmDefault": "yes",
            "partition": "Common",
            "name": "cookie"
        }
    ]
}
Retrieve a Virtual State
/mgmt/tm/ltm/virtual/{name}?ver=11.5.0{?expandSubcollections}

Returns a specific Virtual.

  • Parameters
  • name
    string (required) Example: test_vs

    The name of the virtual server.

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "profilesReference": {
        "items": [
          {
              "context": "all",
              "selfLink": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles/~Common~http?ver=11.5.0",
              "generation": 1210128,
              "fullPath": "/Common/http",
              "partition": "Common",
              "name": "http",
              "kind": "tm:ltm:virtual:profiles:profilesstate"
          },
          {
              "context": "all",
              "selfLink": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles/~Common~tcp?ver=11.5.0",
              "generation": 1210128,
              "fullPath": "/Common/tcp",
              "partition": "Common",
              "name": "tcp",
              "kind": "tm:ltm:virtual:profiles:profilesstate"
          }
        ],
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles?ver=11.5.0"
    },
    "policiesReference": {
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/policies?ver=11.5.0"
    },
    "fwRulesReference": {
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/fw-rules?ver=11.5.0"
    },
    "vsIndex": 161045,
    "rules": [
        "/Common/test_rule",
        "/Common/test_rule2"
    ],
    "vlansDisabled": null,
    "translatePort": "enabled",
    "translateAddress": "enabled",
    "synCookieStatus": "not-activated",
    "sourcePort": "preserve",
    "sourceAddressTranslation": {},
    "source": "0.0.0.0/0",
    "rateLimitSrcMask": 0,
    "rateLimitMode": "object",
    "rateLimitDstMask": 0,
    "rateLimit": "disabled",
    "pool": "/Common/test_pool",
    "connectionLimit": 0,
    "cmpEnabled": "yes",
    "autoLasthop": "default",
    "selfLink": "https://localhost/mgmt/tm/ltm/virtual/test_vs?expandSubcollections=true&ver=11.5.0",
    "generation": 1210128,
    "fullPath": "test_vs",
    "name": "test_vs",
    "kind": "tm:ltm:virtual:virtualstate",
    "destination": "/Common/8.8.8.8:80",
    "enabled": null,
    "gtmScore": 0,
    "ipProtocol": "tcp",
    "mask": "255.255.255.255",
    "mirror": "disabled",
    "mobileAppTunnel": "disabled",
    "nat64": "disabled",
    "fallbackPersistence": "/Common/source_addr",
    "persist": [
        {
            "tmDefault": "yes",
            "partition": "Common",
            "name": "cookie"
        }
    ]
}
Delete a Virtual
/mgmt/tm/ltm/virtual/{name}?ver=11.5.0{?expandSubcollections}

Delete a Virtual. The current user must be the same user who created the Virtual. It returns the deleted Virtual on success.

  • Parameters
  • name
    string (required) Example: test_vs

    The name of the virtual server.

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200

Virtual Collection State 

A Collection of posts.

Create a Virtual
/mgmt/tm/ltm/virtual?ver=11.5.0{?expandSubcollections}

Create a new Virtual object. Mentions and hashtags will be parsed out of the post text, as will bare URLs…

The following persist attributes are all valid when creating or updating a virtual resource:

 {
     "persist": "cookie"
 }

{
    "persist": [
        "cookie"
    ]
}

 {
     "persist": [
         {
             "name": "cookie",
             "tmDefault": "yes"
         }
     ]
 }
  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {
    "name": "test_vs",
    "destination": "8.8.8.8:80",
    "source": "0.0.0.0/0",
    "profiles": [
        "http",
        "my_ssl"
    ],
    "persist": "cookie",
    "fallbackPersistence": "source_addr"
}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "profilesReference": {
        "items": [
          {
              "context": "all",
              "selfLink": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles/~Common~http?ver=11.5.0",
              "generation": 1210128,
              "fullPath": "/Common/http",
              "partition": "Common",
              "name": "http",
              "kind": "tm:ltm:virtual:profiles:profilesstate"
          },
          {
              "context": "all",
              "selfLink": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles/~Common~tcp?ver=11.5.0",
              "generation": 1210128,
              "fullPath": "/Common/tcp",
              "partition": "Common",
              "name": "tcp",
              "kind": "tm:ltm:virtual:profiles:profilesstate"
          }
        ],
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/profiles?ver=11.5.0"
    },
    "policiesReference": {
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/policies?ver=11.5.0"
    },
    "fwRulesReference": {
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/virtual/~Common~test_vs/fw-rules?ver=11.5.0"
    },
    "vsIndex": 161045,
    "rules": [
        "/Common/test_rule",
        "/Common/test_rule2"
    ],
    "vlansDisabled": null,
    "translatePort": "enabled",
    "translateAddress": "enabled",
    "synCookieStatus": "not-activated",
    "sourcePort": "preserve",
    "sourceAddressTranslation": {},
    "source": "0.0.0.0/0",
    "rateLimitSrcMask": 0,
    "rateLimitMode": "object",
    "rateLimitDstMask": 0,
    "rateLimit": "disabled",
    "pool": "/Common/test_pool",
    "connectionLimit": 0,
    "cmpEnabled": "yes",
    "autoLasthop": "default",
    "selfLink": "https://localhost/mgmt/tm/ltm/virtual/test_vs?expandSubcollections=true&ver=11.5.0",
    "generation": 1210128,
    "fullPath": "test_vs",
    "name": "test_vs",
    "kind": "tm:ltm:virtual:virtualstate",
    "destination": "/Common/8.8.8.8:80",
    "enabled": null,
    "gtmScore": 0,
    "ipProtocol": "tcp",
    "mask": "255.255.255.255",
    "mirror": "disabled",
    "mobileAppTunnel": "disabled",
    "nat64": "disabled",
    "fallbackPersistence": "/Common/source_addr",
    "persist": [
        {
            "tmDefault": "yes",
            "partition": "Common",
            "name": "cookie"
        }
    ]
}
Retrieve all Virtual States
/mgmt/tm/ltm/virtual?ver=11.5.0{?expandSubcollections}

Retrieves all posts.

  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "items": [
        {
            "name": "test_vs",
            "kind": "tm:ltm:virtual:virtualstate",
            "...": "..."
        }
    ],
    "selfLink": "https://localhost/mgmt/tm/ltm/virtual?expandSubcollections=true&ver=11.5.0",
    "kind": "tm:ltm:virtual:virtualcollectionstate"
}

Client SSL 

This section groups iControl Client SLL profiles.

Client SSL State 

Retrieve a Client SSL State
/mgmt/tm/ltm/profile/client-ssl/{name}?ver=11.5.0

Returns a specific Virtual.

  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "certKeyChain": [
        {
            "key": "/Common/default.key",
            "cert": "/Common/default.crt",
            "name": "default"
        }
    ],
    "uncleanShutdown": "enabled",
    "strictResume": "disabled",
    "sslSignHash": "any",
    "sslForwardProxyBypass": "disabled",
    "sslForwardProxy": "disabled",
    "sniRequire": "false",
    "sniDefault": "false",
    "sessionTicket": "disabled",
    "secureRenegotiation": "require",
    "retainCertificate": "true",
    "certLookupByIpaddrPort": "disabled",
    "certLifespan": 30,
    "certExtensionIncludes": [
        "basic-constraints",
        "subject-alternative-name"
    ],
    "cert": "/Common/default.crt",
    "cacheTimeout": 3600,
    "cacheSize": 262144,
    "authenticateDepth": 9,
    "authenticate": "once",
    "kind": "tm:ltm:profile:client-ssl:client-sslstate",
    "name": "wom-default-clientssl",
    "partition": "Common",
    "fullPath": "/Common/wom-default-clientssl",
    "generation": 1,
    "selfLink": "https://localhost/mgmt/tm/ltm/profile/client-ssl/~Common~wom-default-clientssl?ver=11.5.0",
    "alertTimeout": "10",
    "allowNonSsl": "enabled",
    "ciphers": "DEFAULT",
    "defaultsFrom": "/Common/clientssl",
    "forwardProxyBypassDefaultAction": "intercept",
    "genericAlert": "enabled",
    "handshakeTimeout": "10",
    "inheritCertkeychain": "true",
    "key": "/Common/default.key",
    "modSslMethods": "disabled",
    "mode": "enabled",
    "tmOptions": [
        "dont-insert-empty-fragments"
    ],
    "peerCertMode": "ignore",
    "proxySsl": "disabled",
    "renegotiateMaxRecordDelay": "indefinite",
    "renegotiatePeriod": "indefinite",
    "renegotiateSize": "indefinite",
    "renegotiation": "enabled"
}

Client SSL Collection State 

A Collection of client ssl profiles.

Retrieve all Client SSL States
/mgmt/tm/ltm/profile/client-ssl?ver=11.5.0

Retrieves all posts.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "items": [
        {
            "kind": "tm:ltm:profile:client-ssl:client-sslstate",
            "name": "wom-default-clientssl",
            "...": "..."
        }
    ],
    "selfLink": "https://localhost/mgmt/tm/ltm/profile/client-ssl?ver=11.5.0",
    "kind": "tm:ltm:profile:client-ssl:client-sslcollectionstate"
}

Pool 

This section groups iControl Pools.

Pool State 

Modify a Pool
/mgmt/tm/ltm/pool/{name}?ver=11.5.0{?expandSubcollections}

Modifies the pool.

  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {
    "members": [
        "10.73.251.74:80"
    ]
}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "membersReference": {
        "items": [
            {
                "state": "down",
                "connectionLimit": 0,
                "address": "10.73.251.75",
                "selfLink": "https://localhost/mgmt/tm/ltm/pool/~Common~test_pool/members/~Common~10.73.251.75:80?ver=11.5.0",
                "generation": 1355740,
                "fullPath": "/Common/10.73.251.75:80",
                "partition": "Common",
                "name": "10.73.251.75:80",
                "kind": "tm:ltm:pool:members:membersstate",
                "dynamicRatio": 1,
                "inheritProfile": "enabled",
                "logging": "disabled",
                "monitor": "default",
                "priorityGroup": 0,
                "rateLimit": "disabled",
                "ratio": 1,
                "session": "monitor-enabled"
            }
        ],
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/pool/~Common~test_pool/members?ver=11.5.0"
    },
    "slowRampTime": 10,
    "reselectTries": 0,
    "queueTimeLimit": 0,
    "queueOnConnectionLimit": "disabled",
    "queueDepthLimit": 0,
    "monitor": "/Common/http ",
    "minUpMembersChecking": "disabled",
    "ignorePersistedWeight": "disabled",
    "allowSnat": "yes",
    "allowNat": "yes",
    "selfLink": "https://localhost/mgmt/tm/ltm/pool/test_pool?expandSubcollections=true&ver=11.5.0",
    "generation": 1355740,
    "fullPath": "test_pool",
    "name": "test_pool",
    "kind": "tm:ltm:pool:poolstate",
    "ipTosToClient": "pass-through",
    "ipTosToServer": "pass-through",
    "linkQosToClient": "pass-through",
    "linkQosToServer": "pass-through",
    "loadBalancingMode": "round-robin",
    "minActiveMembers": 0,
    "minUpMembers": 0,
    "minUpMembersAction": "failover"
}
Retrieve a Pool State
/mgmt/tm/ltm/pool/{name}?ver=11.5.0{?expandSubcollections}

Returns a specific pool state.

  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "membersReference": {
        "items": [
            {
                "state": "down",
                "connectionLimit": 0,
                "address": "10.73.251.75",
                "selfLink": "https://localhost/mgmt/tm/ltm/pool/~Common~test_pool/members/~Common~10.73.251.75:80?ver=11.5.0",
                "generation": 1355740,
                "fullPath": "/Common/10.73.251.75:80",
                "partition": "Common",
                "name": "10.73.251.75:80",
                "kind": "tm:ltm:pool:members:membersstate",
                "dynamicRatio": 1,
                "inheritProfile": "enabled",
                "logging": "disabled",
                "monitor": "default",
                "priorityGroup": 0,
                "rateLimit": "disabled",
                "ratio": 1,
                "session": "monitor-enabled"
            }
        ],
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/pool/~Common~test_pool/members?ver=11.5.0"
    },
    "slowRampTime": 10,
    "reselectTries": 0,
    "queueTimeLimit": 0,
    "queueOnConnectionLimit": "disabled",
    "queueDepthLimit": 0,
    "monitor": "/Common/http ",
    "minUpMembersChecking": "disabled",
    "ignorePersistedWeight": "disabled",
    "allowSnat": "yes",
    "allowNat": "yes",
    "selfLink": "https://localhost/mgmt/tm/ltm/pool/test_pool?expandSubcollections=true&ver=11.5.0",
    "generation": 1355740,
    "fullPath": "test_pool",
    "name": "test_pool",
    "kind": "tm:ltm:pool:poolstate",
    "ipTosToClient": "pass-through",
    "ipTosToServer": "pass-through",
    "linkQosToClient": "pass-through",
    "linkQosToServer": "pass-through",
    "loadBalancingMode": "round-robin",
    "minActiveMembers": 0,
    "minUpMembers": 0,
    "minUpMembersAction": "failover"
}
Delete a Pool
/mgmt/tm/ltm/pool/{name}?ver=11.5.0{?expandSubcollections}
  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200

Pool Collection State 

A Collection of client ssl profiles.

Retrieve all Pool States
/mgmt/tm/ltm/pool?ver=11.5.0{?expandSubcollections}

Retrieves all posts.

  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "items": [
        {
            "name": "test_pool",
            "kind": "tm:ltm:pool:poolstate",
            "...": "..."
        }
    ],
    "selfLink": "https://localhost/mgmt/tm/ltm/pool?expandSubcollections=true&ver=11.5.0",
    "kind": "tm:ltm:pool:poolcollectionstate"
}
Create a Pool
/mgmt/tm/ltm/pool?ver=11.5.0{?expandSubcollections}

Create a new Virtual object. Mentions and hashtags will be parsed out of the post text, as will bare URLs…

  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {
    "name": "test_pool",
    "monitor": "http",
    "members": [
        "10.73.251.74:80"
    ]
}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "membersReference": {
        "items": [
            {
                "state": "down",
                "connectionLimit": 0,
                "address": "10.73.251.75",
                "selfLink": "https://localhost/mgmt/tm/ltm/pool/~Common~test_pool/members/~Common~10.73.251.75:80?ver=11.5.0",
                "generation": 1355740,
                "fullPath": "/Common/10.73.251.75:80",
                "partition": "Common",
                "name": "10.73.251.75:80",
                "kind": "tm:ltm:pool:members:membersstate",
                "dynamicRatio": 1,
                "inheritProfile": "enabled",
                "logging": "disabled",
                "monitor": "default",
                "priorityGroup": 0,
                "rateLimit": "disabled",
                "ratio": 1,
                "session": "monitor-enabled"
            }
        ],
        "isSubcollection": true,
        "link": "https://localhost/mgmt/tm/ltm/pool/~Common~test_pool/members?ver=11.5.0"
    },
    "slowRampTime": 10,
    "reselectTries": 0,
    "queueTimeLimit": 0,
    "queueOnConnectionLimit": "disabled",
    "queueDepthLimit": 0,
    "monitor": "/Common/http ",
    "minUpMembersChecking": "disabled",
    "ignorePersistedWeight": "disabled",
    "allowSnat": "yes",
    "allowNat": "yes",
    "selfLink": "https://localhost/mgmt/tm/ltm/pool/test_pool?expandSubcollections=true&ver=11.5.0",
    "generation": 1355740,
    "fullPath": "test_pool",
    "name": "test_pool",
    "kind": "tm:ltm:pool:poolstate",
    "ipTosToClient": "pass-through",
    "ipTosToServer": "pass-through",
    "linkQosToClient": "pass-through",
    "linkQosToServer": "pass-through",
    "loadBalancingMode": "round-robin",
    "minActiveMembers": 0,
    "minUpMembers": 0,
    "minUpMembersAction": "failover"
}

Rule 

This section groups iControl Rules.

Rule State 

Modify a Rule
/mgmt/tm/ltm/rule/{name}?ver=11.5.0

Modifies the rule.

  • Parameters
  • name
    string (required) Example: test_rule2

    Name of Client SSL profile

  • RequestToggle
  • Body
    {
    "apiAnonymous": "when CLIENT_ACCEPTED {\n\tset tmm_auth_ssl_cc_ldap_sid 0\n\tset tmm_auth_ssl_cc_ldap_done 0\n}"
}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "apiAnonymous": "when CLIENT_ACCEPTED {\n        set tmm_auth_ssl_cc_ldap_sid 0\n        set tmm_auth_ssl_cc_ldap_done 0\n}",
    "selfLink": "https://localhost/mgmt/tm/ltm/rule/~Common~test_rule2?ver=11.5.0",
    "generation": 1,
    "fullPath": "/Common/test_rule2",
    "partition": "Common",
    "name": "test_rule2",
    "kind": "tm:ltm:rule:rulestate"
}
Retrieve a Rule State
/mgmt/tm/ltm/rule/{name}?ver=11.5.0

Returns a specific rule state.

  • Parameters
  • name
    string (required) Example: test_rule2

    Name of Client SSL profile

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "apiAnonymous": "when CLIENT_ACCEPTED {\n        set tmm_auth_ssl_cc_ldap_sid 0\n        set tmm_auth_ssl_cc_ldap_done 0\n}",
    "selfLink": "https://localhost/mgmt/tm/ltm/rule/~Common~test_rule2?ver=11.5.0",
    "generation": 1,
    "fullPath": "/Common/test_rule2",
    "partition": "Common",
    "name": "test_rule2",
    "kind": "tm:ltm:rule:rulestate"
}
Delete a Rule
/mgmt/tm/ltm/rule/{name}?ver=11.5.0
  • Parameters
  • name
    string (required) Example: test_rule2

    Name of Client SSL profile

  • Response  200

Rule Collection State 

A Collection of client ssl profiles.

Retrieve all Rule States
/mgmt/tm/ltm/rule?ver=11.5.0

Retrieves all posts.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "items": [
        {
            "name": "test_rule2",
            "kind": "tm:ltm:rule:rulestate",
            "...": "..."
        }
    ],
    "selfLink": "https://localhost/mgmt/tm/ltm/rule?ver=11.5.0",
    "kind": "tm:ltm:rule:rulecollectionstate"
}
Create a Rule
/mgmt/tm/ltm/rule?ver=11.5.0

Create a new Virtual object. Mentions and hashtags will be parsed out of the post text, as will bare URLs…

  • RequestToggle
  • Body
    {
    "name": "test_rule4",
    "apiAnonymous": "when CLIENT_ACCEPTED {\n\tset tmm_auth_ssl_cc_ldap_sid 0\n\tset tmm_auth_ssl_cc_ldap_done 0\n}"
}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
    "apiAnonymous": "when CLIENT_ACCEPTED {\n        set tmm_auth_ssl_cc_ldap_sid 0\n        set tmm_auth_ssl_cc_ldap_done 0\n}",
    "selfLink": "https://localhost/mgmt/tm/ltm/rule/~Common~test_rule2?ver=11.5.0",
    "generation": 1,
    "fullPath": "/Common/test_rule2",
    "partition": "Common",
    "name": "test_rule2",
    "kind": "tm:ltm:rule:rulestate"
}

NET 

NET Collection State 

Retrieve all NET States
/mgmt/tm/net?ver=11.5.0

Retrieves all NET module components

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "items": [
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/cos?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/fdb?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/ipsec?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/rate-shaping?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/tunnels?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/arp?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/bwc-policy?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/dns-resolver?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/interface?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/lldp-globals?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/ndp?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/packet-filter?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/packet-filter-trusted?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/port-mirror?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/route?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/route-domain?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/router-advertisement?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/self?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/self-allow?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/stp?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/stp-globals?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/trunk?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/vlan?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/vlan-group?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/net/wccp?ver=11.5.0"
      }
    }
  ],
  "selfLink": "https://localhost/mgmt/tm/net?ver=11.5.0",
  "kind": "tm:net:netcollectionstate"
}

VLAN 

This section groups iControl VLANs.

VLAN State 

Modify a VLAN
/mgmt/tm/net/vlan/{name}?ver=11.5.0{?expandSubcollections}
  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "interfacesReference": {
    "items": [
      {
        "tagged": null,
        "selfLink": "https://localhost/mgmt/tm/net/vlan/~Common~test_vlan/interfaces/1.2?ver=11.5.0",
        "generation": 39587,
        "fullPath": "1.2",
        "name": "1.2",
        "kind": "tm:net:vlan:interfaces:interfacesstate"
      }
    ],
    "isSubcollection": true,
    "link": "https://localhost/mgmt/tm/net/vlan/~Common~test_vlan/interfaces?ver=11.5.0"
  },
  "tag": 465,
  "dagRoundRobin": "disabled",
  "cmpHash": "default",
  "autoLasthop": "default",
  "selfLink": "https://localhost/mgmt/tm/net/vlan/test_vlan?expandSubcollections=true&ver=11.5.0",
  "generation": 39587,
  "fullPath": "test_vlan",
  "name": "test_vlan",
  "kind": "tm:net:vlan:vlanstate",
  "failsafe": "disabled",
  "failsafeAction": "failover-restart-tm",
  "failsafeTimeout": 90,
  "ifIndex": 6512,
  "learning": "enable-forward",
  "mtu": 1500,
  "sflow": {
    "samplingRateGlobal": "yes",
    "samplingRate": 0,
    "pollIntervalGlobal": "yes",
    "pollInterval": 0
  },
  "sourceChecking": "disabled"
}
Retrieve a VLAN State
/mgmt/tm/net/vlan/{name}?ver=11.5.0{?expandSubcollections}
  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "interfacesReference": {
    "items": [
      {
        "tagged": null,
        "selfLink": "https://localhost/mgmt/tm/net/vlan/~Common~test_vlan/interfaces/1.2?ver=11.5.0",
        "generation": 39587,
        "fullPath": "1.2",
        "name": "1.2",
        "kind": "tm:net:vlan:interfaces:interfacesstate"
      }
    ],
    "isSubcollection": true,
    "link": "https://localhost/mgmt/tm/net/vlan/~Common~test_vlan/interfaces?ver=11.5.0"
  },
  "tag": 465,
  "dagRoundRobin": "disabled",
  "cmpHash": "default",
  "autoLasthop": "default",
  "selfLink": "https://localhost/mgmt/tm/net/vlan/test_vlan?expandSubcollections=true&ver=11.5.0",
  "generation": 39587,
  "fullPath": "test_vlan",
  "name": "test_vlan",
  "kind": "tm:net:vlan:vlanstate",
  "failsafe": "disabled",
  "failsafeAction": "failover-restart-tm",
  "failsafeTimeout": 90,
  "ifIndex": 6512,
  "learning": "enable-forward",
  "mtu": 1500,
  "sflow": {
    "samplingRateGlobal": "yes",
    "samplingRate": 0,
    "pollIntervalGlobal": "yes",
    "pollInterval": 0
  },
  "sourceChecking": "disabled"
}
Delete a VLAN
/mgmt/tm/net/vlan/{name}?ver=11.5.0{?expandSubcollections}
  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200

VLAN Collection State 

Retrieve all VLAN States
/mgmt/tm/net/vlan?ver=11.5.0{?expandSubcollections}
  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "items": [
    {
      "name": "test_vlan",
      "kind": "tm:net:vlan:vlanstate",
      "...": "...",
      }
    }
  ],
  "selfLink": "https://localhost/mgmt/tm/net/vlan?expandSubcollections=true&ver=11.5.0",
  "kind": "tm:net:vlan:vlancollectionstate"
}
Create a VLAN
/mgmt/tm/net/vlan?ver=11.5.0{?expandSubcollections}
  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "interfacesReference": {
    "items": [
      {
        "tagged": null,
        "selfLink": "https://localhost/mgmt/tm/net/vlan/~Common~test_vlan/interfaces/1.2?ver=11.5.0",
        "generation": 39587,
        "fullPath": "1.2",
        "name": "1.2",
        "kind": "tm:net:vlan:interfaces:interfacesstate"
      }
    ],
    "isSubcollection": true,
    "link": "https://localhost/mgmt/tm/net/vlan/~Common~test_vlan/interfaces?ver=11.5.0"
  },
  "tag": 465,
  "dagRoundRobin": "disabled",
  "cmpHash": "default",
  "autoLasthop": "default",
  "selfLink": "https://localhost/mgmt/tm/net/vlan/test_vlan?expandSubcollections=true&ver=11.5.0",
  "generation": 39587,
  "fullPath": "test_vlan",
  "name": "test_vlan",
  "kind": "tm:net:vlan:vlanstate",
  "failsafe": "disabled",
  "failsafeAction": "failover-restart-tm",
  "failsafeTimeout": 90,
  "ifIndex": 6512,
  "learning": "enable-forward",
  "mtu": 1500,
  "sflow": {
    "samplingRateGlobal": "yes",
    "samplingRate": 0,
    "pollIntervalGlobal": "yes",
    "pollInterval": 0
  },
  "sourceChecking": "disabled"
}

Self 

This section groups iControl Selfs.

Self State 

Modify a Self
/mgmt/tm/net/self/{name}?ver=11.5.0{?expandSubcollections}
  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "fwRulesReference": {
    "isSubcollection": true,
    "link": "https://localhost/mgmt/tm/net/self/~Common~sf_00b_f_auto/fw-rules?ver=11.5.0"
  },
  "vlan": "/Common/vlan460_00b_auto",
  "unit": 1,
  "trafficGroup": "/Common/traffic-group-1",
  "kind": "tm:net:self:selfstate",
  "name": "sf_00b_f_auto",
  "fullPath": "sf_00b_f_auto",
  "generation": 39588,
  "selfLink": "https://localhost/mgmt/tm/net/self/sf_00b_f_auto?expandSubcollections=true&ver=11.5.0",
  "address": "10.73.251.68/27",
  "floating": "enabled",
  "inheritedTrafficGroup": "false"
}
Retrieve a Self State
/mgmt/tm/net/self/{name}?ver=11.5.0{?expandSubcollections}
  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "fwRulesReference": {
    "isSubcollection": true,
    "link": "https://localhost/mgmt/tm/net/self/~Common~sf_00b_f_auto/fw-rules?ver=11.5.0"
  },
  "vlan": "/Common/vlan460_00b_auto",
  "unit": 1,
  "trafficGroup": "/Common/traffic-group-1",
  "kind": "tm:net:self:selfstate",
  "name": "sf_00b_f_auto",
  "fullPath": "sf_00b_f_auto",
  "generation": 39588,
  "selfLink": "https://localhost/mgmt/tm/net/self/sf_00b_f_auto?expandSubcollections=true&ver=11.5.0",
  "address": "10.73.251.68/27",
  "floating": "enabled",
  "inheritedTrafficGroup": "false"
}
Delete a Self
/mgmt/tm/net/self/{name}?ver=11.5.0{?expandSubcollections}
  • Parameters
  • name
    string (required) Example: wom-default-clientssl

    Name of Client SSL profile

    expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200

Self Collection State 

Retrieve all Self States
/mgmt/tm/net/self?ver=11.5.0{?expandSubcollections}
  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "items": [
    {
      "kind": "tm:net:self:selfstate",
      "name": "test_self",
      "...": "...",
    }
  ],
  "selfLink": "https://localhost/mgmt/tm/net/self?ver=11.5.0",
  "kind": "tm:net:self:selfcollectionstate"
}
Create a Self
/mgmt/tm/net/self?ver=11.5.0{?expandSubcollections}
  • Parameters
  • expandSubcollections
    string (optional) Example: true

    Expand the subcollection of the API.

  • RequestToggle
  • Body
    {}
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "fwRulesReference": {
    "isSubcollection": true,
    "link": "https://localhost/mgmt/tm/net/self/~Common~sf_00b_f_auto/fw-rules?ver=11.5.0"
  },
  "vlan": "/Common/vlan460_00b_auto",
  "unit": 1,
  "trafficGroup": "/Common/traffic-group-1",
  "kind": "tm:net:self:selfstate",
  "name": "sf_00b_f_auto",
  "fullPath": "sf_00b_f_auto",
  "generation": 39588,
  "selfLink": "https://localhost/mgmt/tm/net/self/sf_00b_f_auto?expandSubcollections=true&ver=11.5.0",
  "address": "10.73.251.68/27",
  "floating": "enabled",
  "inheritedTrafficGroup": "false"
}

SYS 

SYS Collection State 

Retrieve all SYS States
/mgmt/tm/sys?ver=11.5.0

Retrieves all ltm module components

  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {
  "items": [
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/application?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/crypto?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/daemon-log-settings?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/disk?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/file?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/icall?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/log-config?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/sflow?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/software?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/url-db?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/cluster?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/config?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/daemon-ha?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/datastor?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/db?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/dns?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/feature-module?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/folder?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/global-settings?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/ha-group?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/httpd?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/log-rotate?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/management-dhcp?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/management-ip?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/management-route?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/ntp?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/outbound-smtp?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/provision?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/scriptd?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/service?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/smtp-server?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/snmp?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/sshd?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/state-mirroring?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/syslog?ver=11.5.0"
      }
    },
    {
      "reference": {
        "link": "https://localhost/mgmt/tm/sys/ucs?ver=11.5.0"
      }
    }
  ],
  "selfLink": "https://localhost/mgmt/tm/sys?ver=11.5.0",
  "kind": "tm:sys:syscollectionstate"
}

Generated by aglio on 18 Sep 2014