Jump to

• Request
• Response

1-Configure the Master Data Center for MDC

post

/oam/services/rest/mdc/master

To be executed only on the master data center. Creates the MDC configurations in the master and generates the required cloning artifacts that will need to be applied on the clone

Request

Supported Media Types

• application/json

Body ()

These input parameters direct the MDC topology, the Data Center that needs to be configured as a MDC clone, and the various credentials/certificates needed for the coupling the two data centers

Root Schema : configureMasterParameters

Type: object

Show Source

• accessClientPassword: string
  Password to be used for the MDC NAP agents in Master and Clone
• agentKeyPassword(optional): string
  Agent Key Password used to register partners in CERT mode. when the Managed Servers are in CERT Mode
• artifactPassword: string
  Password used for protecting the cloning artifacts
• artifactsZipLocation(optional): string
  Location where cloning artifacts has to be stored. OPTIONAL - To be specified if cloning artifacts has to be stored in any location other than /tmp
• certModeKeystorePassword(optional): string
  KeyStore Password used to protect clientTrustStore.jks and clientKeyStore.jks. when the Managed Servers are in CERT Mode
• cloneAdminUserNamePassword(optional): string
  UserName:Password of Clone DC Administrator. OPTIONAL - To be specified when the Master and Clone Admin Users/Password are different
• cloneMDCAgentID: string
  Mdc Nap Agent Name for Clone
• cloneServerPolicyManagerURL: string
  URL of the clone policy manager endpoint or the URL of the reverse proxy front-ending the clone policy manager.
• cloneServerURL: string
  URL of the clone admin server or the URL of the reverse proxy front-ending the clone admin server
• forceOverWrite(optional): string
  true|false. OPTIONAL - To OverWrite the Existing MDC Configuration or to recover from Inconsistent State
• keyStorePath(optional): string
  In case of SIMPLE mode, Path to oamclient-keystore.jks file. OPTIONAL - To be speciifed when the oamclient-keystore.jks file is present in any folder other than %DOMAIN_HOME%/output/webgate-ssl-SHA-256. In case of CERT mode, Path to clientKeyStore.jks file. OPTIONAL - To be speciifed when the clientKeyStore.jks file is present in any folder other than %DOMAIN_HOME%/config/fmwconfig/oam-mdc-cert-artifacts
• masterMDCAgentID: string
  Mdc Nap Agent Name for Master
• masterServerPolicyManagerURL: string
  URL of the master policy manager endpoint or the URL of the reserse proxy front-ending the master policy manager.
• masterServerURL(optional): string
  URL of the master admin server. OPTIONAL - to be specified only when master admin server is front-ended by reverse proxy
• mdcTopologyType: string
  ACTIVE_ACTIVE|DISASTER_RECOVERY
• trustStorePath(optional): string
  In case of SIMPLE mode, Path to oamclient-truststore.jks file. OPTIONAL - To be speciifed when the oamclient-truststore.jks file is present in any folder other than %DOMAIN_HOME%/output/webgate-ssl-SHA-256. In case of CERT mode, Path to clientTrustStore.jks file. OPTIONAL - To be speciifed when the clientTrustStore.jks file is present in any folder other than %DOMAIN_HOME%/config/fmwconfig/oam-mdc-cert-artifacts

{
    "type":"object",
    "required":[
        "mdcTopologyType",
        "masterMDCAgentID",
        "cloneMDCAgentID",
        "accessClientPassword",
        "artifactPassword",
        "cloneServerURL",
        "cloneServerPolicyManagerURL",
        "masterServerPolicyManagerURL"
    ],
    "properties":{
        "mdcTopologyType":{
            "type":"string",
            "description":"ACTIVE_ACTIVE|DISASTER_RECOVERY"
        },
        "masterMDCAgentID":{
            "type":"string",
            "description":"Mdc Nap Agent Name for Master"
        },
        "cloneMDCAgentID":{
            "type":"string",
            "description":"Mdc Nap Agent Name for Clone"
        },
        "accessClientPassword":{
            "type":"string",
            "description":"Password to be used for the MDC NAP agents in Master and Clone"
        },
        "artifactPassword":{
            "type":"string",
            "description":"Password used for protecting the cloning artifacts"
        },
        "cloneServerURL":{
            "type":"string",
            "description":"URL of the clone admin server or the URL of the reverse proxy front-ending the clone admin server"
        },
        "cloneServerPolicyManagerURL":{
            "type":"string",
            "description":"URL of the clone policy manager endpoint or the URL of the reverse proxy front-ending the clone policy manager."
        },
        "agentKeyPassword":{
            "type":"string",
            "description":"Agent Key Password used to register partners in CERT mode. when the Managed Servers are in CERT Mode"
        },
        "certModeKeystorePassword":{
            "type":"string",
            "description":"KeyStore Password used to protect clientTrustStore.jks and clientKeyStore.jks. when the Managed Servers are in CERT Mode"
        },
        "masterServerURL":{
            "type":"string",
            "description":"URL of the master admin server. OPTIONAL - to be specified only when master admin server is front-ended by reverse proxy"
        },
        "masterServerPolicyManagerURL":{
            "type":"string",
            "description":"URL of the master policy manager endpoint or the URL of the reserse proxy front-ending the master policy manager."
        },
        "cloneAdminUserNamePassword":{
            "type":"string",
            "description":"UserName:Password of Clone DC Administrator. OPTIONAL - To be specified when the Master and Clone Admin Users/Password are different"
        },
        "trustStorePath":{
            "type":"string",
            "description":"In case of SIMPLE mode, Path to oamclient-truststore.jks file. OPTIONAL - To be speciifed when the oamclient-truststore.jks file is present in any folder other than %DOMAIN_HOME%/output/webgate-ssl-SHA-256. In case of CERT mode, Path to clientTrustStore.jks file. OPTIONAL - To be speciifed when the clientTrustStore.jks file is present in any folder other than %DOMAIN_HOME%/config/fmwconfig/oam-mdc-cert-artifacts"
        },
        "keyStorePath":{
            "type":"string",
            "description":"In case of SIMPLE mode, Path to oamclient-keystore.jks file. OPTIONAL -  To be speciifed when the oamclient-keystore.jks file is present in any folder other than %DOMAIN_HOME%/output/webgate-ssl-SHA-256. In case of CERT mode, Path to clientKeyStore.jks file. OPTIONAL - To be speciifed when the clientKeyStore.jks file is present in any folder other than %DOMAIN_HOME%/config/fmwconfig/oam-mdc-cert-artifacts"
        },
        "artifactsZipLocation":{
            "type":"string",
            "description":"Location where cloning artifacts has to be stored. OPTIONAL - To be specified if cloning artifacts has to be stored in any location other than /tmp"
        },
        "forceOverWrite":{
            "type":"string",
            "description":"true|false. OPTIONAL - To OverWrite the Existing MDC Configuration or to recover from Inconsistent State"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The required MDC configurations were setup on the master DC, and the required clong artifatcs were generated successfully

Body ()

Root Schema : responseConfigureMaster

Type: object

Show Source

• responseCode(optional): string
• responseDetails(optional): object responseDetails
• responseText(optional): string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseText":{
            "type":"string"
        },
        "responseDetails":{
            "type":"object",
            "properties":{
                "ArtifactsDownloadLocation":{
                    "type":"string"
                },
                "ServerMode":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : responseDetails

Type: object

Show Source

• ArtifactsDownloadLocation(optional): string
• ServerMode(optional): string

{
    "type":"object",
    "properties":{
        "ArtifactsDownloadLocation":{
            "type":"string"
        },
        "ServerMode":{
            "type":"string"
        }
    }
}

400 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

401 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

500 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

504 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

Back to Top