Skip to main content

"group"

The replication "group" object usage details

Abstract

The replication group object usage details

The "group" object contains actions to manage availability groups.

Note

The synonym "availability_group" can also be used. It is equivalent to "group".

Examples

"create" with publication definition example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "group": {
    "actions": [
      "create"
      ],
    "name": "group1",
    "engines":[
      {
        "name":"FAIRCOMS@HOST100",
        "primary":true,
        "synchronized":true,
        "publication": {
          "name": "pubctreeSQL",
          "create":  true,
          "mode": "db",
          "dbname": "ctreeSQL"
        }
      },
      {
        "name":"FAIRCOMS@HOST450",
        "synchronized":true,
        "primary":false
      }
    ]
  }
}

"create" with multiple actions example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "group": {
    "actions": [
      "create",
      "deploy",
      "start"
    ],
    "name": "group001040",
    "engines":[
      {
        "name":"FAIRCOMS@HOST001",
        "primary":true,
        "synchronized":true,
        "publication": {
          "name": "pubFiles",
          "create":  false
        }
      },
      {
        "name":"FAIRCOMS@HOST040",
        "synchronized":true,
        "primary":false
      }
    ]
  }
}

"deploy" example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "group": {
    "actions": [
      "deploy"
    ],
    "name": "group0012"
  }
}

"start" example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "options": {
    "profile": true,
    "ignoredeploy": true
  },
  "group": {
    "actions": [
      "start"
    ],
    "name": "groupCompany12"
  }
}

"stop" example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "group": {
    "actions": [
      "stop"
    ],
    "name": "availGroup57"
  }
}

"delete" example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "group": {
    "actions": [
      "delete"
    ],
    "name": "availGroup46"
  }
}

Properties summary

Table 1. "group" actions summary

Property

Description

create

creates an availability group

delete

deletes the specified availability group

deploy

deploys the specified availability group

start

starts a previously stopped availability group

Note

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

stop

stops the specified availability group



"create"

The "create" action creates a new group.

Properties summary

Table 2. "create" actions summary

Property

Description

Type

name

specifies the name of the group

string

engines

contains a list of servers composing the availability group

array of objects



"deploy"

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

Things to know:

  • "deploy" can be specified together with the "create" action.

  • If the group already exists, only the group name is required.

  • The "deploy" action implies the start of the group.

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

"delete"

The "delete" action deletes the specified availability group.

Things to know:

  • The related replication plan that was created by the group deployment and its publication will not be deleted by the operation.

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