Configuring Docker Run Time Options
Configuring Docker Run Time Options
POST http://<mgmt_IP>/api/mo/sys/apphosting/appconf-<app-id>/runopt-<opt-idx>.json
{
"apphostingRunOpt" : {
"attributes" : {
"adminSt" : "enabled",
"optIdx" : "1",
"optVal": "-v $(APP_DATA):/data"
}
}
}
{
"apphostingRunOpt" : {
"attributes" : {
"adminSt" : "disabled”,
"optIdx" : "1"
}
}
}
{
imdata:[]
}
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload.
Configure docker run time options
app-hosting appid te_app
app-resource docker
run-opts 1 “-v $(APP_DATA):/data”
exit
Unconfigure docker run time options
app-hosting appid te_app
app-resource docker
no run-opts 1 “-v $(APP_DATA):/data”
exit
Note: The property information for this example was added in release 10.3(1)F.
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| apphostingAppHosting | sys/apphosting |
| apphostingRunOpt | sys/apphosting/appconf-appid/runopt-optidx |
appHostingRunOpt Properties
The following table contains information about the appHostingRunOpt properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
| Property Name | Data Type | Values | Description |
|---|---|---|---|
| adminSt | scalar: Enum8 | Selection: 1: enabled 2: disabled Default: disabled | Admin Status |
| optIdx | scalar: Unit32 | Range: [1,30] Default: 1 | Package runtime option index |
| optVal | string: Basic | Range: [1,235] | Package runtime option value |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide: