Skip to content

Commit

Permalink
add docs for new create IPMI pool params
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabe Conradi committed Mar 6, 2017
1 parent 3885084 commit 632dfbd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions _data/api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ sections:
generate_ipmi:
type: Option[Boolean]
description: "True or false. Defaults to true if <code>asset_type</code> is <code>SERVER_NODE</code>"
ipmi_pool:
type: Option[String]
description: If provided, this overrides the default IPMI pool to allocate OOB IP from. This only takes effect if `generate_ipmi=true`. Default is empty, which uses whatever the currently configured IPMI address pool is.
status:
type: Option[Status]
description: A valid status, if specified. Defaults to Incomplete.
Expand All @@ -26,10 +29,15 @@ sections:
description: One of SERVER_NODE, SERVER_CHASSIS, RACK, SWITCH, ROUTER, POWER_CIRCUIT or POWER_STRIP. Defaults to SERVER_NODE. If additional asset types are added to the database, they can also be specified.
response_codes:
201: Asset was successfully created
400: IPMI pool provided does not exist
409: Asset with specified tag already exists
examples:
collins-shell: collins-shell asset create --tag=TAG [--ipmi=(true|false) --status=STATUS --type=TYPE]
curl: curl --basic -u blake:admin:first -X PUT http://localhost:9000/api/asset/tumblrtag30
collins-client-ruby: |
c.create!('test01', generate_ipmi: true) # default IPMI pool
c.create!('test02', generate_ipmi: true, ipmi_pool: 'OOB-POD03')
c.create!('config_vip', type: :configuration, generate_ipmi: false, status: :allocated)
responses:
json: |
{
Expand Down

0 comments on commit 632dfbd

Please sign in to comment.