Page Comparison

...

Localtabgroup

Localtab

active	true
title	CLI

Getting details of a network partition via the CLI

Overview

CLI command

describe-network-partition

Description Retrieve details of a specific network partition.

Command format

Code Block
describe-network-partition <NETWORK_PARTITION_ID>

Parameter definition

Short option	Long option	Description	Required	Example value
N/A	N/A	The network partition ID	Yes	`network-partition-1`

Example

Retrieving the details of the network partition with the id: network-partition-1.

Code Block
describe-network-partition network-partition-1

Sample output

Code Block

{
  "id": "network-partition-1",
  "provider": "mock",
  "partitions": [
    {
      "id": "partition-1",
      "property": [
        {
          "name": "region",
          "value": "default"
        }
      ]
    },
    {
      "id": "partition-2",
      "property": [
        {
          "name": "region",
          "value": "default"
        }
      ]
    }
  ]
}

Localtab

title	REST API

Getting details of a network partition via the REST API

Overview

Description Retrieve details of a specific network partition.

Resource Path /networkPartitions/{networkPartitionId}

HTTP Method GET

Request/Response Format application/json

Command format

Code Block
curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/networkPartitions/{networkPartitionId}

Info
By default, `<USERNAME>:<PASSWORD>` is `admin:admin`. By default, `<PRIVATE_PAAS_HOST>` is `localhost.` However, if you are using a public IP, the respective IP address or domain needs to be specified. By default, `<PRIVATE_PAAS_HTTPS_PORT>` has been set to 9443. However, if the port offset has been incremented by `n`, the default port value needs to be incremented by `n`.

Example

Retrieving the details of the network partition with the id: network-partition-1 .

Code Block
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/networkPartitions/network-partition-1

Sample output

Code Block

> GET /api/networkPartitions/network-partition-1 HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Fri, 02 Oct 2015 11:45:13 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"id":"network-partition-1","partitions":[{"id":"partition-1","property":[{"name":"region","value":"default"}]},{"id":"partition-2","property":[{"name":"region","value":"default"}]}],"provider":"mock"}

You will come across the following HTTP status codes while retrieving details of a specific network partition:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Localtab

title	PPaaS Console

Getting details of a network partition via the PPaaS Console

Follow the instructions below to get details of a network partition:

Click Configurations on the home page.
Click Network Partitions.
Hover your mouse pointer over the network partition definition you wish to view details on for the Details button to appear and click Details.
Update the network partition details as required. For property definitions, see the Network Partition Resource Definition.
Image Removed
Click SAVE to update the network partition.