Floatingips
post__floatingips_create
Code samples
POST /floatingips/create HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /floatingips/create
Create a floating ip.
Body parameter
{
"Name": "string",
"Address": "string",
"Mask": "string",
"Gateway": "string",
"Nodes": [
"string"
],
"Interfaces": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | FloatingIpElementCreate | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__floatingips_delete
Code samples
DELETE /floatingips/delete HTTP/1.1
Accept: application/json
DELETE /floatingips/delete
Delete a floating ip.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | The floating ip to delete. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__floatingips_edit
Code samples
PUT /floatingips/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /floatingips/edit
Edit a floating ip.
Body parameter
{
"Name": "string",
"Address": "string",
"Mask": "string",
"Gateway": "string",
"Nodes": [
"string"
],
"Interfaces": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | FloatingIpElementEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__floatingips_list
Code samples
GET /floatingips/list HTTP/1.1
Accept: application/json
GET /floatingips/list
List all floating ips.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | Filter floating ips by name. |
| ip | query | string | false | Filter floating ips by ip. |
Example responses
200 Response
{
"Data": [
{
"Name": "string",
"Address": "string",
"Mask": "string",
"Gateway": "string",
"OwnerNode": "string",
"Nodes": [
"string"
],
"Interfaces": [
"string"
],
"NodeInterfaces": [
{
"Name": "string",
"Id": 0,
"Time": "2019-08-24T14:15:22Z",
"State": "Running",
"HAState": "Unknown",
"CurrentManagementConnection": true,
"Vols": 0,
"Iqn": "string",
"IsSEDPasswordSupplied": true,
"Wwn": [
"string"
],
"Volumes": [
"string"
],
"Sensors": [
{
"Name": "string",
"Type": "Temperture",
"Reading": "string",
"EventMessage": "string",
"Status": "OK",
"State": "string",
"LastReadingTimestamp": "2019-08-24T14:15:22Z"
}
],
"Services": [
"string"
],
"Sessions": [
"string"
],
"SupportTunnelStatus": "string",
"Drives": [
{
"Name": "string",
"Id": 0,
"Device": "string",
"UsedCapacityInBytes": 0,
"ManualPool": "string",
"DeviceName": "string",
"PhysicalSector": "string",
"LogicalSector": "string",
"Vendor": "string",
"Model": "string",
"RotationRate": "string",
"EnclosureIndex": "string",
"OSName": "string",
"Version": "string",
"SelfEncryptingDrive": "NotSupported",
"Sensors": [
{
"Name": "string",
"Type": "Temperture",
"Reading": "string",
"EventMessage": "string",
"Status": "OK",
"State": "string",
"LastReadingTimestamp": "2019-08-24T14:15:22Z"
}
],
"LedState": "string",
"Type": "HDD",
"CapacityInBytes": 0,
"ApprovedState": "Approved",
"ResourceSerial": "string",
"ResourceStatus": "OK",
"ErrMsg": "string"
}
],
"CPU": [
{
"Name": "string",
"Id": 0,
"Vendor": "string",
"Brand": "string",
"Model": "string",
"Family": "string",
"Stepping": "string",
"CoreCount": "string",
"LogicalCoresCount": "string",
"ProcessorID": "string",
"Sensors": [
{
"Name": "string",
"Type": "Temperture",
"Reading": "string",
"EventMessage": "string",
"Status": "OK",
"State": "string",
"LastReadingTimestamp": "2019-08-24T14:15:22Z"
}
],
"ResourceSerial": "string",
"ResourceStatus": "OK",
"ErrMsg": "string"
}
],
"Memory": [
{
"Name": "string",
"Id": 0,
"Manufacturer": "string",
"Capacity": "string",
"MemoryType": "string",
"Serial": "string",
"Sensors": [
{
"Name": "string",
"Type": "Temperture",
"Reading": "string",
"EventMessage": "string",
"Status": "OK",
"State": "string",
"LastReadingTimestamp": "2019-08-24T14:15:22Z"
}
],
"ResourceSerial": "string",
"ResourceStatus": "OK",
"ErrMsg": "string"
}
],
"NetworkInterfaceCards": [
{
"Name": "string",
"Id": 0,
"Interface": "string",
"Device": "string",
"Vendor": "string",
"Slaves": [
"string"
],
"Ips": [
{
"Ip": "string",
"IscsiEnabled": true,
"TcpNvmeofPorts": [
"string"
],
"RdmaNvmeofPorts": [
"string"
],
"TcpNvmeofEnabled": true,
"RdmaNvmeofEnabled": true
}
],
"SpeedGbs": 0,
"Sensors": [
{
"Name": "string",
"Type": "Temperture",
"Reading": "string",
"EventMessage": "string",
"Status": "OK",
"State": "string",
"LastReadingTimestamp": "2019-08-24T14:15:22Z"
}
],
"ResourceSerial": "string",
"ResourceStatus": "OK",
"ErrMsg": "string"
}
],
"FibreChannelHostBusAdapters": [
{
"Name": "string",
"Id": 0,
"Model": "string",
"FirmwareVersion": "string",
"DriverVersion": "string",
"LinkState": "string",
"Sensors": [
{
"Name": "string",
"Type": "Temperture",
"Reading": "string",
"EventMessage": "string",
"Status": "OK",
"State": "string",
"LastReadingTimestamp": "2019-08-24T14:15:22Z"
}
],
"ResourceSerial": "string",
"ResourceStatus": "OK",
"ErrMsg": "string"
}
],
"Chassis": [
{
"Name": "string",
"Id": 0,
"Sensors": [
{
"Name": "string",
"Type": "Temperture",
"Reading": "string",
"EventMessage": "string",
"Status": "OK",
"State": "string",
"LastReadingTimestamp": "2019-08-24T14:15:22Z"
}
],
"ProductVendor": "string",
"ProductName": "string",
"ProductVersion": "string",
"ProductSerial": "string",
"ProductUUID": "string",
"BoardVendor": "string",
"BoardName": "string",
"BoardVersion": "string",
"BoardSerial": "string",
"BiosVendor": "string",
"BiosVersion": "string",
"ChassisType": "string",
"ChassisSerial": "string",
"ChassisVendor": "string",
"ServerVendor": "string",
"IsVirtualMachine": true,
"ResourceSerial": "string",
"ResourceStatus": "OK",
"ErrMsg": "string"
}
],
"Pings": [
{
"PingType": "string",
"Address": "string",
"Error": "string",
"Nics": [
"string"
],
"IsSuccessful": true
}
],
"IpAddresses": [
"string"
],
"TargetChap": {
"ChapName": "string",
"ChapSecret": "string"
},
"Isns": {
"IsnsAddress": "string",
"AccessControl": true
}
}
],
"PairedFloatingIps": [
{
"Name": "string",
"RemoteSystemId": 0,
"RemoteSystemName": "string",
"Address": "string"
}
]
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | FloatingIpElementApiResult |
| 400 | Bad Request | Bad Request | string |
post__floatingips_pair
Code samples
POST /floatingips/pair HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /floatingips/pair
Pair a local floating ip to a remote floating ip. This is useful when replicating NAS/Object.
Body parameter
{
"Name": "string",
"TargetSystem": "string",
"TargetFloatingIp": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | FloatingipsPair | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__floatingips_unpair
Code samples
DELETE /floatingips/unpair HTTP/1.1
Accept: application/json
DELETE /floatingips/unpair
Unpair a local floating ip from a remote floating ip.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | Local floating ip. |
| targetSystem | query | string | false | Target system for the floating ip unpairing. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
No Comments