Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
Configuring Docker Run Time Options
DME
Copy
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"
        }
    }
}

Response
{
    imdata:[]
}

Configuring Docker Run Time Options

Configuring Docker Run Time Options


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.

MODN
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 NameData TypeValuesDescription
adminStscalar: Enum8Selection:
1: enabled
2: disabled
Default: disabled		Admin Status
optIdxscalar: Unit32Range: [1,30]
Default: 1		Package runtime option index
optValstring: BasicRange: [1,235]Package runtime option value


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Next