Skip to main content
ZStack
Resource Center/Hardware/SAN Storage Operations/iSCSI Server Operations

AddIscsiServer

AddIscsiServer

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

Operation ID

AddIscsiServer

Since

3.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • name
      String

      Optional. The resource name.

    • ip
      StringRequired

      The IP address.

    • port
      Integer

      Optional. The port. Default port: 3260.

    • chapUserName
      String

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

    • chapUserPassword
      String

      Optional. The CHAP password. Default value: null.

    • resourceUuid
      String

      Optional. The resource UUID.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

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

    • code
      StringRequired

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

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

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

  • inventory
    IscsiServerInventoryRequired

    See inventory.

    • uuid
      StringRequired

      The resource UUID.

    • name
      StringRequired

      The resource name.

    • ip
      StringRequired

      The IP address.

    • port
      IntegerRequired

      The port.

    • chapUserName
      StringRequired

      The CHAP user name.

    • chapUserPassword
      StringRequired

      The CHAP password.

    • state
      StringRequired

      The state.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • iscsiTargets
      ListRequired

      See iscsiTargets.

      • iscsiServerUuid
        StringRequired

        The iSCSI server UUID.

      • uuid
        StringRequired

        The resource UUID.

      • iqn
        StringRequired

        The iSCSI IQN.

      • createDate
        TimestampRequired

        The creation date.

      • lastOpDate
        TimestampRequired

        The last operation date.

      • iscsiLuns
        ListRequired

        See iscsiLuns.

        • uuid
          StringRequired

          The resource UUID.

        • iscsiTargetUuid
          StringRequired

          The iSCSI target UUID.

        • wwid
          StringRequired

          The device WWID.

        • vendor
          StringRequired

          The device vendor.

        • model
          StringRequired

          The device model.

        • wwn
          StringRequired

          The device WWN.

        • serial
          StringRequired

          The device serial No.

        • hctl
          StringRequired

          The SCSI device HCTL.

        • type
          StringRequired

          The device type.

        • path
          StringRequired

          The device path.

        • size
          LongRequired

          The device size.

        • createDate
          TimestampRequired

          The creation date.

        • lastOpDate
          TimestampRequired

          The last operation date.

    • iscsiClusterRefs
      ListRequired

      See iscsiClusterRefs.

      • iscsiServerUuid
        StringRequired

        The iscsi server UUID.

      • clusterUuid
        StringRequired

        The cluster UUID.

      • createDate
        TimestampRequired

        The creation date.

      • lastOpDate
        TimestampRequired

        The last operation date.