Jump to

• Request
• Response

Get NetworkConfig object.

get

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

get NetworkConfig 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

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : NetworkConfig

Type: object

Network configuration attributes.

Show Source

• adminBgpAuthentication(required): boolean
• adminBgpEncrypted(required): boolean
• adminBgpHoldDownTimer(required): integer
• adminBgpKeepAliveTimer(required): integer
• adminBgpPassword(required): string
  Maximum Length: 80
• adminCidr(required): string
  Maximum Length: 64
• adminDnsIp1(required): ip
• adminDnsIp2(required): ip
• adminDnsIp3(required): ip
• adminGateway(required): ip
• adminIsStaticRouting(required): boolean
• adminLacpFast(required): boolean
• adminMgmt01Hostname(required): string
  Maximum Length: 64
• adminMgmt01Ip(required): ip
• adminMgmt02Hostname(required): string
  Maximum Length: 64
• adminMgmt02Ip(required): ip
• adminMgmt03Hostname(required): string
  Maximum Length: 64
• adminMgmt03Ip(required): ip
• adminMgmtVip(required): ip
• adminMgmtVipHostname(required): string
  Maximum Length: 64
• adminMtu(required): integer
• adminNetmask(required): string
  Maximum Length: 64
• adminPeer1Asn(required): integer
• adminPeer1Ip(required): string
  Maximum Length: 64
• adminPeer2Asn(required): integer
• adminPeer2Ip(required): string
  Maximum Length: 64
• adminPortCount(required): integer
• adminPortFec(required): string
  Allowed Values: [ "OFF", "AUTO", "FCFEC", "RSCONS16", "RSFEC", "RSIEEE" ]
• adminPortSpeed(required): integer
• adminRouterGroup(required): integer
• adminSpine1Ip(required): string
  Maximum Length: 64
• adminSpine2Ip(required): string
  Maximum Length: 64
• adminSpineVip(required): ip
• adminTopology(required): string
  Allowed Values: [ "TRIANGLE", "SQUARE", "MESH" ]
• adminVlan(required): integer
• bgpAuthentication(required): boolean
• bgpEncrypted(required): boolean
• bgpHoldDownTimer(required): integer
• bgpKeepAliveTimer(required): integer
• bgpPassword(required): string
  Maximum Length: 100
• dnsIp1(required): ip
• dnsIp2(required): ip
• dnsIp3(required): ip
• enableAdminNetwork(required): boolean
• errorMessage: string
  Maximum Length: 64
• faultIds: array faultIds
• freePublicIps: string
  Maximum Length: 64
• lifecycleState: string
  Maximum Length: 64
• mgmt01Hostname(required): string
  Maximum Length: 64
• mgmt01Ip(required): ip
• mgmt02Hostname(required): string
  Maximum Length: 64
• mgmt02Ip(required): ip
• mgmt03Hostname(required): string
  Maximum Length: 64
• mgmt03Ip(required): ip
• mgmtVip(required): ip
• mgmtVipHostname(required): string
  Maximum Length: 64
• ntpIps(required): string
  Maximum Length: 512
• objectStorageIp(required): ip
• oracleAsn(required): integer
• peer1Asn(required): integer
• peer1Ip(required): string
  Maximum Length: 64
• peer2Asn(required): integer
• peer2Ip(required): string
  Maximum Length: 64
• publicIps(required): string
  Maximum Length: 512
• spine1Ip(required): string
  Maximum Length: 64
• spine2Ip(required): string
  Maximum Length: 64
• spineVip(required): ip
• uplinkGateway(required): ip
• uplinkIsStaticRouting(required): boolean
• uplinkLacpFast(required): boolean
• uplinkMtu(required): integer
• uplinkNetmask(required): string
  Maximum Length: 64
• uplinkPortCount(required): integer
• uplinkPortFec(required): string
  Allowed Values: [ "OFF", "AUTO", "FCFEC", "RSCONS16", "RSFEC", "RSIEEE" ]
• uplinkPortSpeed(required): integer
• uplinkRouterGroup(required): integer
• uplinkTopology(required): string
  Allowed Values: [ "TRIANGLE", "SQUARE", "MESH" ]
• uplinkVlan(required): integer
• zfsCapacityPoolReplicationEndpoint(required): ip
• zfsPerfPoolReplicationEndpoint(required): ip

{
    "properties":{
        "uplinkPortSpeed":{
            "description":"",
            "type":"integer"
        },
        "uplinkPortCount":{
            "description":"",
            "type":"integer"
        },
        "uplinkMtu":{
            "description":"",
            "type":"integer"
        },
        "spine1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "spine2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "uplinkNetmask":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "uplinkLacpFast":{
            "description":"",
            "type":"boolean"
        },
        "ntpIps":{
            "description":"",
            "maxLength":512,
            "type":"string"
        },
        "uplinkPortFec":{
            "description":"",
            "enum":[
                "OFF",
                "AUTO",
                "FCFEC",
                "RSCONS16",
                "RSFEC",
                "RSIEEE"
            ],
            "type":"string"
        },
        "publicIps":{
            "description":"",
            "maxLength":512,
            "type":"string"
        },
        "dnsIp1":{
            "description":"",
            "type":"ip"
        },
        "dnsIp2":{
            "description":"",
            "type":"ip"
        },
        "dnsIp3":{
            "description":"",
            "type":"ip"
        },
        "mgmt01Hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "mgmt02Hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "mgmt03Hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "mgmt01Ip":{
            "description":"",
            "type":"ip"
        },
        "mgmt02Ip":{
            "description":"",
            "type":"ip"
        },
        "mgmt03Ip":{
            "description":"",
            "type":"ip"
        },
        "mgmtVipHostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "mgmtVip":{
            "description":"",
            "type":"ip"
        },
        "objectStorageIp":{
            "description":"",
            "type":"ip"
        },
        "uplinkIsStaticRouting":{
            "description":"",
            "type":"boolean"
        },
        "spineVip":{
            "description":"",
            "type":"ip"
        },
        "uplinkGateway":{
            "description":"",
            "type":"ip"
        },
        "uplinkVlan":{
            "description":"",
            "type":"integer"
        },
        "uplinkRouterGroup":{
            "description":"",
            "type":"integer"
        },
        "peer1Asn":{
            "description":"",
            "type":"integer"
        },
        "peer1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "oracleAsn":{
            "description":"",
            "type":"integer"
        },
        "uplinkTopology":{
            "description":"",
            "enum":[
                "TRIANGLE",
                "SQUARE",
                "MESH"
            ],
            "type":"string"
        },
        "peer2Asn":{
            "description":"",
            "type":"integer"
        },
        "peer2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "bgpAuthentication":{
            "description":"",
            "type":"boolean"
        },
        "bgpPassword":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "bgpKeepAliveTimer":{
            "description":"",
            "type":"integer"
        },
        "bgpHoldDownTimer":{
            "description":"",
            "type":"integer"
        },
        "lifecycleState":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "enableAdminNetwork":{
            "description":"",
            "type":"boolean"
        },
        "adminPortSpeed":{
            "description":"",
            "type":"integer"
        },
        "adminPortCount":{
            "description":"",
            "type":"integer"
        },
        "adminMtu":{
            "description":"",
            "type":"integer"
        },
        "adminPortFec":{
            "description":"",
            "enum":[
                "OFF",
                "AUTO",
                "FCFEC",
                "RSCONS16",
                "RSFEC",
                "RSIEEE"
            ],
            "type":"string"
        },
        "adminVlan":{
            "description":"",
            "type":"integer"
        },
        "adminSpine1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminSpine2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminSpineVip":{
            "description":"",
            "type":"ip"
        },
        "adminNetmask":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminGateway":{
            "description":"",
            "type":"ip"
        },
        "adminLacpFast":{
            "description":"",
            "type":"boolean"
        },
        "adminCidr":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminRouterGroup":{
            "description":"",
            "type":"integer"
        },
        "adminDnsIp1":{
            "description":"",
            "type":"ip"
        },
        "adminDnsIp2":{
            "description":"",
            "type":"ip"
        },
        "adminDnsIp3":{
            "description":"",
            "type":"ip"
        },
        "adminMgmt01Hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminMgmt02Hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminMgmt03Hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminMgmt01Ip":{
            "description":"",
            "type":"ip"
        },
        "adminMgmt02Ip":{
            "description":"",
            "type":"ip"
        },
        "adminMgmt03Ip":{
            "description":"",
            "type":"ip"
        },
        "adminMgmtVipHostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminMgmtVip":{
            "description":"",
            "type":"ip"
        },
        "adminPeer1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminPeer1Asn":{
            "description":"",
            "type":"integer"
        },
        "adminPeer2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "adminPeer2Asn":{
            "description":"",
            "type":"integer"
        },
        "adminTopology":{
            "description":"",
            "enum":[
                "TRIANGLE",
                "SQUARE",
                "MESH"
            ],
            "type":"string"
        },
        "adminBgpAuthentication":{
            "description":"",
            "type":"boolean"
        },
        "adminBgpPassword":{
            "description":"",
            "maxLength":80,
            "type":"string"
        },
        "adminBgpKeepAliveTimer":{
            "description":"",
            "type":"integer"
        },
        "adminBgpHoldDownTimer":{
            "description":"",
            "type":"integer"
        },
        "adminIsStaticRouting":{
            "description":"",
            "type":"boolean"
        },
        "zfsCapacityPoolReplicationEndpoint":{
            "description":"",
            "type":"ip"
        },
        "zfsPerfPoolReplicationEndpoint":{
            "description":"",
            "type":"ip"
        },
        "freePublicIps":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "errorMessage":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "bgpEncrypted":{
            "description":"",
            "type":"boolean"
        },
        "adminBgpEncrypted":{
            "description":"",
            "type":"boolean"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "uplinkPortSpeed",
        "uplinkPortCount",
        "uplinkMtu",
        "spine1Ip",
        "spine2Ip",
        "uplinkNetmask",
        "uplinkLacpFast",
        "ntpIps",
        "uplinkPortFec",
        "publicIps",
        "dnsIp1",
        "dnsIp2",
        "dnsIp3",
        "mgmt01Hostname",
        "mgmt02Hostname",
        "mgmt03Hostname",
        "mgmt01Ip",
        "mgmt02Ip",
        "mgmt03Ip",
        "mgmtVipHostname",
        "mgmtVip",
        "objectStorageIp",
        "uplinkIsStaticRouting",
        "spineVip",
        "uplinkGateway",
        "uplinkVlan",
        "uplinkRouterGroup",
        "peer1Asn",
        "peer1Ip",
        "oracleAsn",
        "uplinkTopology",
        "peer2Asn",
        "peer2Ip",
        "bgpAuthentication",
        "bgpPassword",
        "bgpKeepAliveTimer",
        "bgpHoldDownTimer",
        "enableAdminNetwork",
        "adminPortSpeed",
        "adminPortCount",
        "adminMtu",
        "adminPortFec",
        "adminVlan",
        "adminSpine1Ip",
        "adminSpine2Ip",
        "adminSpineVip",
        "adminNetmask",
        "adminGateway",
        "adminLacpFast",
        "adminCidr",
        "adminRouterGroup",
        "adminDnsIp1",
        "adminDnsIp2",
        "adminDnsIp3",
        "adminMgmt01Hostname",
        "adminMgmt02Hostname",
        "adminMgmt03Hostname",
        "adminMgmt01Ip",
        "adminMgmt02Ip",
        "adminMgmt03Ip",
        "adminMgmtVipHostname",
        "adminMgmtVip",
        "adminPeer1Ip",
        "adminPeer1Asn",
        "adminPeer2Ip",
        "adminPeer2Asn",
        "adminTopology",
        "adminBgpAuthentication",
        "adminBgpPassword",
        "adminBgpKeepAliveTimer",
        "adminBgpHoldDownTimer",
        "adminIsStaticRouting",
        "zfsCapacityPoolReplicationEndpoint",
        "zfsPerfPoolReplicationEndpoint",
        "bgpEncrypted",
        "adminBgpEncrypted"
    ],
    "type":"object",
    "description":"Network configuration attributes."
}

Nested Schema : faultIds

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