Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add IPMI Pools Docs #533

Merged
merged 1 commit into from
Apr 7, 2017
Merged

Add IPMI Pools Docs #533

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions _data/api.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1842,6 +1842,34 @@ sections:
]
}
}
"get IPMI address pools":
description: Return ipmi pools that are configured
request: GET /api/ipmi/pools
permission: controllers.IpmiApi.GetAddressPools
note: If no IPMI pools are configured the parent level ipmi block settings are returned with a pool name of default. In the case of the parent level IPMI block being set as well pools defined only the pools will be returned due to some legacy code around ipmi pool loading.
response_codes:
200: Pools found
examples:
collins-shell: collins-shell ipmi pools
curl: curl --basic -u blake:admin:first http://localhost:9000/api/ipmi/pools
responses:
json: |
{
"status": "success:ok",
"data": {
"POOLS": [
{
"NAME": "OOB-POD01",
"NETWORK": "172.16.32.0/20",
"START_ADDRESS": "172.16.32.20",
"SPECIFIED_GATEWAY": "Unspecified",
"GATEWAY": "172.16.32.1",
"BROADCAST": "172.16.47.255",
"POSSIBLE_ADDRESSES": 4094
}
]
}
}
"asset addresses":
description: Return addresses associated with an asset
request: GET /api/asset/:tag/addresses
Expand Down