In this lab, the iControl REST API will be used to provision a module on the BIG-IP. More specifically, the Advanced Firewall Manager (AFM) module will be provisioned for use in Lab 2 - CONFIGURING AFM.
Prior to performing the below steps, validate the {{module}} Postman environment variable. The {{module}} should be set to afm.
Follow the Lab 1.3 - BIG-IP Module Provisioning steps in order found in the Postman collection to complete this portion of the lab. The requests and responses have been included below for reference.
注意
Some response content has been removed for brevity.
Request
GET https://{{big_ip_a_mgmt}}/mgmt/tm/sys/provision
Headers
X-F5-Auth-Token: {{big_ip_a_auth_token}}
Example Response
注釈
The afm module is currently provisioned for none while the ltm module is provisioned for nominal.
{
"kind": "tm:sys:provision:provisioncollectionstate",
"selfLink": "https://localhost/mgmt/tm/sys/provision?ver=13.0.0",
"items": [
{
"kind": "tm:sys:provision:provisionstate",
"name": "afm",
"fullPath": "afm",
"generation": 5609,
"selfLink": "https://localhost/mgmt/tm/sys/provision/afm?ver=13.0.0",
"cpuRatio": 0,
"diskRatio": 0,
"level": "none",
"memoryRatio": 0
},
{
"kind": "tm:sys:provision:provisionstate",
"name": "ltm",
"fullPath": "ltm",
"generation": 1,
"selfLink": "https://localhost/mgmt/tm/sys/provision/ltm?ver=13.0.0",
"cpuRatio": 0,
"diskRatio": 0,
"level": "nominal",
"memoryRatio": 0
}
]
}
Request
GET https://{{big_ip_a_mgmt}}/mgmt/tm/sys/provision/{{module}}
Headers
X-F5-Auth-Token: {{big_ip_a_auth_token}}
Example Response
注釈
The afm module is currently not provisioned.
{
"kind": "tm:sys:provision:provisionstate",
"name": "afm",
"fullPath": "afm",
"generation": 5609,
"selfLink": "https://localhost/mgmt/tm/sys/provision/afm?ver=13.0.0",
"cpuRatio": 0,
"diskRatio": 0,
"level": "none",
"memoryRatio": 0
}
The afm module is provisioned using an HTTP PATCH with a body containing a provisioning level to the REST endpoint for mgmt/tm/sys/provision/{{module}}.
Request
PATCH https://{{big_ip_a_mgmt}}/mgmt/tm/sys/provision/{{module}}
Headers
Content-Type: application/json
X-F5-Auth-Token: {{big_ip_a_auth_token}}
Body
{
"level":"nominal"
}
Example Response
注釈
The afm module has been provisioned with a level of nominal.
{
"kind": "tm:sys:provision:provisionstate",
"name": "afm",
"fullPath": "afm",
"generation": 10636,
"selfLink": "https://localhost/mgmt/tm/sys/provision/afm?ver=13.0.0",
"cpuRatio": 0,
"diskRatio": 0,
"level": "nominal",
"memoryRatio": 0
}
注釈
Performing a provision/deprovion operation takes some time to complete. If the original request is still being processed, the below error may be encountered.
{
"code": 400,
"message": "01071003:3: A previous provisioning operation is in progress. Try again when the BIGIP is active.",
"errorStack": [],
"apiError": 3
}
This request is will serve as an example of how to deprovision a BIG-IP module.
Request
PATCH https://{{big_ip_a_mgmt}}/mgmt/tm/sys/provision/{{module}}
Headers
Content-Type: application/json
X-F5-Auth-Token: {{big_ip_a_auth_token}}
Body
{
"level":"none"
}
Example Response
{
"kind": "tm:sys:provision:provisionstate",
"name": "afm",
"fullPath": "afm",
"generation": 10714,
"selfLink": "https://localhost/mgmt/tm/sys/provision/afm?ver=13.0.0",
"cpuRatio": 0,
"diskRatio": 0,
"level": "none",
"memoryRatio": 0
}
Re-provision the afm module if previously deprovisioned.
Request
PATCH https://{{big_ip_a_mgmt}}/mgmt/tm/sys/provision/{{module}}
Headers
Content-Type: application/json
X-F5-Auth-Token: {{big_ip_a_auth_token}}
Body
{
"level":"nominal"
}
Example Response
{
"kind": "tm:sys:provision:provisionstate",
"name": "afm",
"fullPath": "afm",
"generation": 10636,
"selfLink": "https://localhost/mgmt/tm/sys/provision/afm?ver=13.0.0",
"cpuRatio": 0,
"diskRatio": 0,
"level": "nominal",
"memoryRatio": 0
}
Performing a GET on the /mgmt/tm/sys/license endpoint can be used to quickly determine the license registration key used to license a BIG-IP.
Request
GET https://{{big_ip_a_mgmt}}/mgmt/tm/sys/license
Headers
X-F5-Auth-Token: {{big_ip_a_auth_token}}
Example Response
{
"kind": "tm:sys:license:licensestats",
"selfLink": "https://localhost/mgmt/tm/sys/license?ver=13.0.0",
"entries": {
"https://localhost/mgmt/tm/sys/license/0": {
"nestedStats": {
"entries": {
"licenseEndDate": {
"description": "2017/06/10"
},
"licenseStartDate": {
"description": "2017/05/09"
},
"licensedOnDate": {
"description": "2017/05/10"
},
"licensedVersion": {
"description": "13.0.0"
},
"platformId": {
"description": "Z100"
},
"registrationKey": {
"description": "X8851-99962-70001-50517-2945515"
},
"serviceCheckDate": {
"description": "2017/05/10"
},
"https://localhost/mgmt/tm/sys/license/0/active-modules": {
"nestedStats": {
"entries": {
"https://localhost/mgmt/tm/sys/license/0/active-modules/%22BIG-IP,%20VE,%20Lab%22": {
"nestedStats": {
"entries": {
"featureModules": {
"description": "{ \"Rate Shaping\" \"External Interface and Network HSM, VE\" \"SDN Services, VE\" \"SSL, Forward Proxy, VE\" \"DENY-VER-V11.4.0\" \"DNS Services (Lab)\" \"Max Compression, VE\" \"Acceleration Manager, VE\" \"Crytpo Offload, VE, Tier 1 (25M - 200M)\" \"BIG-IP VE, Multicast Routing\" \"Recycle, BIG-IP, VE\" \"Advanced Protocols, VE\" \"APM, Limited\" \"SSL, VE\" \"PSM, VE\" \"Routing Bundle, VE\" \"AFM, VE (Lab ONLY - NO ROUTING)\" \"ASM, VE\" \"Anti-Virus Checks\" \"Base Endpoint Security Checks\" \"Firewall Checks\" \"Machine Certificate Checks\" \"Network Access\" \"Protected Workspace\" \"Secure Virtual Keyboard\" \"APM, Web Application\" \"App Tunnel\" \"Remote Desktop\" \"DNS RATE LIMITED, MAX\" \"CGN, BIG-IP VE, AFM ONLY\" \"DNS Rate Fallback, Unlimited\" \"DNS Licensed Objects, Unlimited\" \"DNS Rate Limit, Unlimited QPS\" }"
},
"key": {
"description": "B020781-2829817"
}
}
}
},
"https://localhost/mgmt/tm/sys/license/0/active-modules/%22CGN,%20VE%20(Lab)%22": {
"nestedStats": {
"entries": {
"featureModules": {
"description": "{ \"Routing Bundle, VE\" }"
},
"key": {
"description": "C206673-7574695"
}
}
}
},
"https://localhost/mgmt/tm/sys/license/0/active-modules/%22DNSSEC%22": {
"nestedStats": {
"entries": {
"key": {
"description": "M001846-0132923"
}
}
}
},
"https://localhost/mgmt/tm/sys/license/0/active-modules/%22GTM,%20VE%20(Lab)%22": {
"nestedStats": {
"entries": {
"featureModules": {
"description": "{ \"IPV6 Gateway\" \"Ram Cache\" \"STP\" \"DNS Express\" }"
},
"key": {
"description": "P695100-5761500"
}
}
}
}
}
}
}
}
}
}
}
}