Skip to main content

"plan"

The "plan" object specifies interactions with replication plans.

Property summary

Table 1. "plan" object properties summary

Property

Description

Type

"create"

creates a specified replication plan

string

"deploy"

starts the deployment of the specified plan

string

"start"

starts a replication plan

string

"stop"

stops an existing replication plan

array

"delete"

deletes an existing publication specified with the name parameter

"resync"

forces the resynchronization of the files specified under a certain publication

Note

a replication plan "name" and a "publication" or list of "files" that belong to the specified plan are required.

"add_subscription"

creates an array of new subscriptions inside a specified existing replication plan

Note

Each subscription can be associated with an existing publication or with a new publication as specified in the "create" action of the "publication" object.

"delete_subscription"

deletes the specified subscriptions from the specified existing replication plan

"show"

shows the details of a replication plan, the servers involved in the replication plan options, and all the subscribed publications

Note

Only "name" is required.



Examples

"create" existing publication example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "create",
    ],
    "name": "planFiles",
    "sourceEngine": "FAIRCOMS@HOST001",
    "destEngine": "FAIRCOM2@HOST002",
    "subscriptions": [
      {
        "name": "subFiles",
        "bidirectional": false,
        "redir": [
        {
          "source": "E:\\sw\\eu_database\\",
          "target": "D:\\backup\\repldata\\"
        }
        ],
        "publication": {
          "name": "pubFiles",
          "create": false
        }
      }
      ]
    }
  }

"create" publication example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "create"
    ],
    "name": "planFiles",
    "sourceEngine": "FAIRCOMS@HOST001",
    "destEngine": "FAIRCOM2@HOST002",
    "subscriptions": [
      {
        "name": "subFiles",
        "bidirectional": false,
        "redir": [
        {
          "source": "Z:\\db",
          "target": "D:\\backup\\repldata\\"
        }
        ],
        "publication": {
          "name": "pubPW",
          "create": true,
          "mode": "folder",
          "item": "Z:\\db\\pw",
          "wildcards": ["*dat"],
          "recursive": true
        }
      }
      ]
    }
  }

"create" (false) of a non-main publication example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN"
  },
  "plan": {
    "actions": [
      "create",
      "deploy",
      "start"
    ],
    "name": "planFiles",
    "sourceEngine": "FAIRCOMS@MAURO-PC",
    "destEngine": "FAIRCOM2@MAURO-PC",
    "subscriptions": [
      {
      "name": "subFiles",
      "bidirectional": false,
      "publication": {
          "name": "pubFiles",
          "create": false
        }
      }
      ]
    }
  }

"create" (true) of a non-main publication example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN"
  },
  "plan": {
    "actions": [
      "create"
    ],
    "name": "planFiles2",
    "sourceEngine": "FAIRCOMS@MAURO-PC",
    "destEngine": "FAIRCOM2@MAURO-PC",
    "subscriptions": [
      {
      "name": "subFiles",
      "bidirectional": false,
      "publication": {
          "name": "pubFiles2",
          "create": true,
          "mode": "files",
          "items": [
            "E:\\sw\\eu_ldf\\dbf\\ML\\*.*dat"
          ]
        }
      }
      ]
    }
  }

"deploy" example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "deploy"
    ],
    "name": "planFiles"
    }
  }

"deploy" with the create of a plan and publication example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "create",
      "deploy"
    ],
    "name": "planFiles",
    "sourceEngine": "FAIRCOMS@HOST001",
    "destEngine": "FAIRCOM2@HOST002",
    "subscriptions": [
      {
        "name": "subFiles",
        "bidirectional": false,
        "redir": [
        {
          "source": "Z:\\db",
          "target": "D:\\backup\\repldata\\"
        }
        ],
        "publication": {
          "name": "pubPW",
          "create": true,
          "mode": "folder",
          "item": "Z:\\db\\pw",
          "wildcards": ["*dat"],
          "recursive": true
        }
      }
      ]
    }
  }

"start" example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "start"
    ],
    "name": "planFiles"
    }
  }

"start" with forced startup without deployment and with plan and publication creation

{
  {
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
     "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": true,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "create",
      "start"
    ],
    "name": "planFiles",
    "sourceEngine": "FAIRCOMS@HOST001",
    "destEngine": "FAIRCOM2@HOST002",
    "subscriptions": [
      {
        "name": "subFiles",
        "bidirectional": false,
        "redir": [
        {
          "source": "Z:\\db",
          "target": "D:\\backup\\repldata\\"
        }
        ],
        "publication": {
          "name": "pubPW",
          "create": true,
          "mode": "folder",
          "item": "Z:\\db\\pw",
          "wildcards": ["*dat"],
          "recursive": true
        }
      }
      ]
    }
  }

"stop" example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
     "pwd": "ADMIN"
  },
  "plan": {
    "actions": [
      "stop"
    ],
    "name": "planDatabase"
    }
  }

"delete" example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "delete"
    ],
    "name": "planFiles"
    }
  }

"delete" with "stop" and "delete" action example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
     "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": true,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "delete",
      "stop"
    ],
    "name": "planFolders"
    }
  }

"resync" publication example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "plan": {
    "actions": [ "resync" ],
    "name": "plan1",
    "publication": "pub3"
  }
}

"resync" list of files example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN"
  }
  "plan": {
    "actions": [ "resync" ],
    "name": "planFiles",
    "files": [
      "E:\\sw\\eu_ldf\\dbf\\ML\\abadata\\c\\custmast.dat",
      "E:\\sw\\eu_ldf\\dbf\\ML\\abadata\\c\\custordr.dat"
  ]
  }
}

"add_subscriptions" two new subscriptions example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": false
  },
  "plan":{
    "actions": "add_subscriptions",
    "name":"planALPHA",
    "subscriptions":[
      {
        "name": "subD",
        "publication": {
          "create":false,
          "name":"pubFilesD"
        }
      },
      {
        "name": "subI",
        "publication":{
            "create":true,
            "name":"pubFilesI",
            "mode":"files",
            "items": [
                "E:\\sw\\eu_ldf\\dbf\\ML\\data\\i\\*.*dat"
              ]
        }
      }
    ]
  }
}

"delete_subscriptions" example

{ "memphis": { "name": "MEMPHIS", "uid": "admin", "pwd": "ADMIN", "port": "7597" }, "options": { "profile": true, "replace": true, "ignoredeploy": false, "recursivedel": false, "recursivesearch": false }, "plan":{ "actions": ["delete_subscriptions"], "name":"planBETA", "subscriptions":[ { "name": "subC", "publication": { "name":"pubFiles" } }, { "name": "subD", "publication": { "name":"pubFilesD" } }, { "name": "subI", "publication":{ "name":"pubFilesI" } } ] }
}

"show" example

{ "memphis": { "name": "MEMPHIS", "uid": "admin", "pwd": "ADMIN", "port": "7597" }, "plan": { "actions": [ "show" ], "name": "planData01" } }

"create"

The "create" action creates a new plan.

Note

The "create" action in "plan" always takes a list of subscriptions and each subscription is associated with an existing or new publication. The "create" action in the "publication" object defines new publications.

Property summary

Table 2. "create" action summaries

Property

Description

Type

"name"

defines the name of the plan

string

"sourceEngine"

contains the logical name of the source engine that is publishing the publication

string

"destEngine"

contains the logical name of the destination engine

string

"subscriptions"

contains a list of subscriptions

array



"deploy"

the "deploy" action starts the deployment of the specified plan.

Things to know:

  • The "plan" can be an existing plan or it can be created and deployed.

  • If the plan or availability group already exists only "name" is required.

  • The "deploy" action implies the start of the replication plan after its successful deployment.

  • This action can be specified together with the "create" action

"start"

The "start" action starts a replication plan.

Things to know:

  • The plan can be created within the same JSON or it can already exist.

  • The plan or group should be deployed to be started correctly, but the "ignoredeploy" main option can override this constraint.

  • You may want to start a plan without the deployment if the target files have already been copied manually.

  • The "start" operation is skipped if the deployment action is requested in the same file.

  • Typically, the "start" operation is used to start plans that have already been stopped.

"stop"

The "stop" action stops an existing replication plan,

Things to know:

  • Only "name" is required.

  • A stopped plan or group may be restarted using the "start" action.

  • It can be run together with "delete".

"delete"

The "delete" action deletes an existing publication specified with the name parameter.

Things to know:

  • Make use of the "recursivedel" option to delete all the dependencies.

  • The plan must be stopped in order to be deleted.

  • The "stop" action can be run together with "delete".

"delete_subscriptions"

The "delete_subscriptions" action deletes the specified subscriptions from the specified existing replication plan.

Things to know:

  • In order to correctly identify the subscription, the associated publication's "name" must also be specified.

  • This command will not remove any of the publications.