REST Resources

/api/space/fabric-management/add-fabric-node

The following operations are supported on this resource:

  • POST - Add a dedicated Database Node to fabric
  • POST - Add a secondary Database Node to fabric
  • POST - Add a Jboss Node to fabric
  • POST - Add a Special Node to fabric
POST /add-fabric-node Version 2

Add a dedicated Database Node to fabric.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /add-fabric-node?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    Name Type URI Type Description Required
    queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
    schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <add-database-fabric-node-request>
         <primary-node>
               <name>Primary_DB</name>
               <ip>192.168.100.1</ip>
               <username>admin</username>
               <password>*******</password>
               <fingerprint>83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11</fingerprint>
         </primary-node>
         <vip>
               <ip-v4-address>192.168.100.3</ip-v4-address>
               <ip-v6-address>2001:db8:168:26:251</ip-v6-address>
         </vip>
         <secondary-node>
               <name>Secondary_DB</name>
               <ip>192.168.100.2</ip>
               <username>admin</username>
               <password>*******</password>
               <fingerprint>83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:12</fingerprint>
         </secondary-node>
    </add-database-fabric-node-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/325898">
      <id>325898</id>
    </task>

  • Sample Input JSON:
    {
       "add-database-fabric-node-request" : {
         "primary-node" : {
           "name" : "Primary_DB" ,
           "ip" : "192.168.100.1" ,
           "username" : "admin" ,
           "password" : "*******" ,
           "fingerprint" : "83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11"
         } ,
         "vip" : {
           "ip-v4-address" : "192.168.100.3" ,
           "ip-v6-address" : "2001:db8:168:26:251"
         } ,
         "secondary-node" : {
           "name" : "Secondary_DB" ,
           "ip" : "192.168.100.2" ,
           "username" : "admin" ,
           "password" : "*******" ,
           "fingerprint" : "83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:12"
         }
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href" : "/api/space/job-management/jobs/325898",
        "id" : 325898
      }
    }

    • Access Control

    The following capabilities are required to access this API: AddNode

    POST /add-fabric-node Version 2

    Add a secondary Database Node to fabric.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /add-fabric-node?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      Name Type URI Type Description Required
      queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
      schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <add-secondary-database-fabric-node-request>
         <secondary-node>
               <name>Secondary-DB-Node</name>
               <ip>192.168.1.2</ip>
               <username>admin</username>
               <password>*******</password>
               <fingerprint>83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11</fingerprint>
         </secondary-node>
    </add-secondary-database-fabric-node-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/326598">
      <id>326598</id>
    </task>

  • Sample Input JSON:
    {
       "add-secondary-database-fabric-node-request" : {
         "secondary-node" : {
           "name" : "Secondary-DB-Node" ,
           "ip" : "192.168.1.2" ,
           "username" : "admin" ,
           "password" : "*******" ,
           "fingerprint" : "83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11"
         }
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href" : "/api/space/job-management/jobs/326598",
        "id" : 326598
      }
    }

    • Access Control

    The following capabilities are required to access this API: AddNode

    POST /add-fabric-node Version 2

    Add a Jboss Node to fabric.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /add-fabric-node?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      Name Type URI Type Description Required
      queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
      schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <add-jboss-fabric-node-request>
         <name>Jboss</name>
         <ip>192.168.100.1</ip>
         <username>admin</username>
         <password>*******</password>
         <fingerprint>83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11</fingerprint>
    </add-jboss-fabric-node-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/327585">
      <id>327585</id>
    </task>

  • Sample Input JSON:
    {
       "add-jboss-fabric-node-request" : {
         "name" : "Jboss" ,
         "ip" : "192.168.100.1" ,
         "username" : "admin" ,
         "password" : "*******" ,
         "fingerprint" : "83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11"
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href" : "/api/space/job-management/jobs/327585",
        "id" : 327585
      }
    }

    • Access Control

    The following capabilities are required to access this API: AddNode

    POST /add-fabric-node Version 2

    Add a Special Node to fabric.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /add-fabric-node?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      Name Type URI Type Description Required
      queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
      schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <add-special-fabric-node-request>
         <name>Special_Node</name>
         <ip>192.168.100.1</ip>
         <user-name>admin</user-name>
         <password>*******</password>
         <fingerprint>83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11</fingerprint>
    </add-special-fabric-node-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/327648">
      <id>327648</id>
    </task>

  • Sample Input JSON:
    {
       "add-special-fabric-node-request" : {
         "name" : "Special_Node" ,
         "ip" : "192.168.100.1" ,
         "user-name" : "admin" ,
         "password" : "*******" ,
         "fingerprint" : "83:ec:f3:a6:a1:74:ad:81:7e:e9:ad:7c:6e:d1:43:11"
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href" : "/api/space/job-management/jobs/327648",
        "id" : 327648
      }
    }

    • Access Control

    The following capabilities are required to access this API: AddNode