Jump to

• Request
• Response

Create a new PeerConnection object.

post

https://{host}:{port}/{basePath}/PeerConnection/

create a new PeerConnection object.

Request

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• peerConnection: object PeerConnection
  The PeerConnection object represents one DR peering between two different PCA racks.

{
    "properties":{
        "peerConnection":{
            "$ref":"#/components/schemas/PeerConnection",
            "type":"object"
        }
    }
}

Nested Schema : PeerConnection

Type: object

The PeerConnection object represents one DR peering between two different PCA racks.

Show Source

• description(required): string
  Maximum Length: 1000
• displayName(required): string
  Maximum Length: 200
• faultIds: array faultIds
• generation: integer
• lifecycleState: string
  Allowed Values: [ "CREATING", "WAITING_FOR_CREATE_PEER_CONNECTION", "WAITING_FOR_PEER", "CREATE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION", "TRUST_EXCHANGE", "SHARING_TRUST", "ACTIVE", "DELETING", "DELETED", "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_DELETE_PEER_CONNECTION", "UPDATING", "UPDATED", "FAILED", "FAILED_DELETING_ZFSSA_PEER_CONNECTION", "FAILED_DELETING_PEER_CONNECTION", "CLEANUP_FAILURE", "CLEANUP_SUCCESS", "UNKNOWN", "ERROR" ]
• lifecycleStateDescription: string
  Maximum Length: 1000
• lifecycleSubState: string
  Allowed Values: [ "CREATING", "WAITING_FOR_PEER", "WAITING_FOR_CREATE_PEER_CONNECTION", "CREATE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION", "TRUST_EXCHANGE", "SHARING_TRUST", "ACTIVE", "DELETING", "DELETED", "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_DELETE_PEER_CONNECTION", "UPDATING", "UPDATED", "FAILED", "FAILED_CREATING_PEERCONNECTION", "FAILED_TRUST_EXCHANGE", "FAILED_ZFSSA_PEERCONNECTION", "CLEANUP_FAILURE", "CLEANUP_SUCCESS", "UNKNOWN", "ERROR" ]
• localEndpoint1Ip(required): string
  Maximum Length: 64
• localEndpoint2Ip(required): string
  Maximum Length: 64
• name(required): string
  Maximum Length: 256
• peerAdminCaChain(required): string
  Maximum Length: 10000
• peerAdminHostname(required): string
  Maximum Length: 64
• peerAdminPassword(required): string
  Maximum Length: 100
• peerAdminUserName(required): string
  Maximum Length: 64
• peerDomainName(required): string
  Maximum Length: 64
• peerSerialNumber(required): string
  Maximum Length: 100
• peerSystemName(required): string
  Maximum Length: 64
• progressRecordIds: array progressRecordIds
• remoteAsn(required): string
  Maximum Length: 64
• remoteEndpoint1Ip(required): string
  Maximum Length: 64
• remoteEndpoint2Ip(required): string
  Maximum Length: 64
• remoteSpine1Ip(required): string
  Maximum Length: 64
• remoteSpine2Ip(required): string
  Maximum Length: 64
• timeCreated: string
  Maximum Length: 64
• timeUpdated: string
  Maximum Length: 64
• workState: string

{
    "properties":{
        "lifecycleSubState":{
            "description":"",
            "enum":[
                "CREATING",
                "WAITING_FOR_PEER",
                "WAITING_FOR_CREATE_PEER_CONNECTION",
                "CREATE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION",
                "TRUST_EXCHANGE",
                "SHARING_TRUST",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_DELETE_PEER_CONNECTION",
                "UPDATING",
                "UPDATED",
                "FAILED",
                "FAILED_CREATING_PEERCONNECTION",
                "FAILED_TRUST_EXCHANGE",
                "FAILED_ZFSSA_PEERCONNECTION",
                "CLEANUP_FAILURE",
                "CLEANUP_SUCCESS",
                "UNKNOWN",
                "ERROR"
            ],
            "type":"string"
        },
        "lifecycleState":{
            "description":"",
            "enum":[
                "CREATING",
                "WAITING_FOR_CREATE_PEER_CONNECTION",
                "WAITING_FOR_PEER",
                "CREATE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION",
                "TRUST_EXCHANGE",
                "SHARING_TRUST",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_DELETE_PEER_CONNECTION",
                "UPDATING",
                "UPDATED",
                "FAILED",
                "FAILED_DELETING_ZFSSA_PEER_CONNECTION",
                "FAILED_DELETING_PEER_CONNECTION",
                "CLEANUP_FAILURE",
                "CLEANUP_SUCCESS",
                "UNKNOWN",
                "ERROR"
            ],
            "type":"string"
        },
        "lifecycleStateDescription":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "displayName":{
            "description":"",
            "maxLength":200,
            "type":"string"
        },
        "peerSerialNumber":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "localEndpoint1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "localEndpoint2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteEndpoint1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteEndpoint2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteSpine1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteSpine2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerAdminCaChain":{
            "description":"",
            "maxLength":10000,
            "type":"string"
        },
        "peerAdminHostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerDomainName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerSystemName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeUpdated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeCreated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerAdminUserName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerAdminPassword":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "remoteAsn":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "progressRecordIds":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "displayName",
        "peerSerialNumber",
        "localEndpoint1Ip",
        "localEndpoint2Ip",
        "remoteEndpoint1Ip",
        "remoteEndpoint2Ip",
        "remoteSpine1Ip",
        "remoteSpine2Ip",
        "peerAdminCaChain",
        "peerAdminHostname",
        "peerDomainName",
        "peerSystemName",
        "peerAdminUserName",
        "peerAdminPassword",
        "remoteAsn",
        "description",
        "name"
    ],
    "type":"object",
    "description":"The PeerConnection object represents one DR peering between two different PCA racks."
}

Nested Schema : faultIds

Type: array

Nested Schema : progressRecordIds

Type: array

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : Job

Type: object

A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects.

Show Source

• abortedUser: string
  Maximum Length: 256
• associatedObjId: string
  Maximum Length: 128
• associatedObjType: string
  Maximum Length: 256
• endTime: timestamp
  Read-only and this operation is unsupported. @param endTime Time in milliseconds.
• jobName(required): string
  Maximum Length: 256
• progressMessage: string
  Maximum Length: 1024

  Read-only and this operation is unsupported. @param progressMessage.
• result: AssociatedObj
• runState: string
  Allowed Values: [ "ACTIVE", "SUCCEEDED", "FAILED", "ABORTED" ]
• startTime: timestamp
  Read-only and this operation is unsupported. @param startTime The startTime to set.
• transcript: string
  Maximum Length: 1000
• username: string
  Maximum Length: 64
• workItemIds: array workItemIds
• workRequestId: string
  Maximum Length: 256

{
    "properties":{
        "result":{
            "description":"",
            "type":"AssociatedObj"
        },
        "associatedObjType":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "associatedObjId":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "workRequestId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "abortedUser":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "endTime":{
            "description":"Read-only and this operation is unsupported. @param endTime Time in milliseconds.",
            "type":"timestamp"
        },
        "jobName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "progressMessage":{
            "description":"Read-only and this operation is unsupported. @param progressMessage.",
            "maxLength":1024,
            "type":"string"
        },
        "runState":{
            "description":"",
            "enum":[
                "ACTIVE",
                "SUCCEEDED",
                "FAILED",
                "ABORTED"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"Read-only and this operation is unsupported. @param startTime The startTime to set.",
            "type":"timestamp"
        },
        "transcript":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "username":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "workItemIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "jobName"
    ],
    "type":"object",
    "description":"A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects."
}

Nested Schema : workItemIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top