diff --git a/v1/api/swagger/components/schemas/VolumeAttachment.yaml b/v1/api/swagger/components/schemas/VolumeAttachment.yaml index 97484d7..c8f2d4d 100644 --- a/v1/api/swagger/components/schemas/VolumeAttachment.yaml +++ b/v1/api/swagger/components/schemas/VolumeAttachment.yaml @@ -14,6 +14,7 @@ allOf: - State - FSConfig - AttachProtocol + - WWPNs properties: VolumeID: type: string @@ -65,4 +66,10 @@ allOf: allOf: - $ref: ./VAFSConfig.yaml AttachProtocol: - $ref: ./ProtocolKind.yaml \ No newline at end of file + $ref: ./ProtocolKind.yaml + WWPNs: + type: array + items: + type: string + example: 20:31:01:02:ad:f2:a8:e5 + description: List of FC host port wwpns. \ No newline at end of file diff --git a/v1/html/index.html b/v1/html/index.html index 763139a..402b246 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -2733,7 +2733,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown"
}

Detach existing volume from Host

Detaches the indicated volume from the host identified in the requestBody. This detachment will delete the VolumeAttachment object that contains details about the connection of the volume and will update the Host to remove selected iSCSI configuration information. +

https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}/attach

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown",
  • "WWPNs": [
    ]
}

Detach existing volume from Host

Detaches the indicated volume from the host identified in the requestBody. This detachment will delete the VolumeAttachment object that contains details about the connection of the volume and will update the Host to remove selected iSCSI configuration information. Note that the HostID is required in the body of the request to ensure that the operation is well understood and that a volume is not accidently being removed from the wrong host. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to attach

@@ -2755,7 +2755,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
[
  • {
    }
]

Create a new VolumeAttachment

Adds a new VolumeAttachment which enables a machine to use a volume. Note that this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
https://client.greenlake.hpe.com{basePath}/volume-attachments

Response samples

Content type
application/json
[
  • {
    }
]

Create a new VolumeAttachment

Adds a new VolumeAttachment which enables a machine to use a volume. Note that this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

NewVolumeAttachement parameters to create a new VolumeAttachment.

@@ -2767,7 +2767,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "My Object Name",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "Protocol": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown"
}

Retrieve volume attachment by ID

Returns a single volume attachment with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
https://client.greenlake.hpe.com{basePath}/volume-attachments

Request samples

Content type
application/json
{
  • "Name": "My Object Name",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "Protocol": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown",
  • "WWPNs": [
    ]
}

Retrieve volume attachment by ID

Returns a single volume attachment with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
attachmentId
required
string

ID of volume attachment to return

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -2777,7 +2777,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown"
}

Delete a VolumeAttachment

Deletes the VolumeAttachment with the matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
https://client.greenlake.hpe.com{basePath}/volume-attachments/{attachmentId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown",
  • "WWPNs": [
    ]
}

Delete a VolumeAttachment

Deletes the VolumeAttachment with the matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
attachmentId
required
string

ID of VolumeAttachment to delete

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -3047,7 +3047,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}