Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/SAN Storage Operations/iSCSI Server Operations
POSTiSCSI Server OperationsSince 3.0.0SynchronousAuth Required

AddIscsiServer

AddIscsiServer

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameString

      Optional. The resource name.

    • ipStringRequired

      The IP address.

    • portInteger

      Optional. The port. Default port: 3260.

    • chapUserNameString

      Optional. The CHAP user name. Default value: null.

    • chapUserPasswordString

      Optional. The CHAP password. Default value: null.

    • resourceUuidString

      Optional. The resource UUID.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryIscsiServerInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • ipStringRequired

      The IP address.

    • portIntegerRequired

      The port.

    • chapUserNameStringRequired

      The CHAP user name.

    • chapUserPasswordStringRequired

      The CHAP password.

    • stateStringRequired

      The state.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • iscsiTargetsListRequired

      See iscsiTargets.

      • iscsiServerUuidStringRequired

        The iSCSI server UUID.

      • uuidStringRequired

        The resource UUID.

      • iqnStringRequired

        The iSCSI IQN.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • iscsiLunsListRequired

        See iscsiLuns.

        • uuidStringRequired

          The resource UUID.

        • iscsiTargetUuidStringRequired

          The iSCSI target UUID.

        • wwidStringRequired

          The device WWID.

        • vendorStringRequired

          The device vendor.

        • modelStringRequired

          The device model.

        • wwnStringRequired

          The device WWN.

        • serialStringRequired

          The device serial No.

        • hctlStringRequired

          The SCSI device HCTL.

        • typeStringRequired

          The device type.

        • pathStringRequired

          The device path.

        • sizeLongRequired

          The device size.

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

    • iscsiClusterRefsListRequired

      See iscsiClusterRefs.

      • iscsiServerUuidStringRequired

        No description provided.

      • clusterUuidStringRequired

        The cluster UUID.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

POST/zstack/v1/storage-devices/iscsi/servers

/zstack/v1/storage-devices/iscsi/servers

Operation ID

AddIscsiServer

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/storage-devices/iscsi/servers' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","ip":"<ip>","port":1,"chapUserName":"<chapUserName>","chapUserPassword":"<chapUserPassword>","resourceUuid":"<resourceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "0b77c2e947ca3b40b79f6342728ec8fc", "name": "iscsi-server-10.0.0.201", "ip": "10.0.0.201", "port": 3260.0, "chapUserName": "username", "chapUserPassword": "password", "state": "Enabled", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }

Change History

This API has no change history records yet.

View all change history