< Back

Enable-CouchDBCluster

Sun Jan 19, 2020 6:29 pm

NAME Enable-CouchDBCluster



SYNOPSIS

Create a new cluster.





SYNTAX

Enable-CouchDBCluster [[-Server] <String>] [[-Port] <Int32>] [[-NodeCount] <Int32>] [-SingleNode] [[-BindAddress]

<String>] [[-BindPort] <Int32>] [[-RemoteNode] <String>] [[-RemoteUser] <String>] [[-RemotePassword]

<SecureString>] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]





DESCRIPTION

Create a new cluster CouchDB server.





PARAMETERS

-Server <String>

The CouchDB server name. Default is localhost.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Port <Int32>

The CouchDB server port. Default is 5984.



Required? false

Position? 2

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-NodeCount <Int32>

Enable CouchDB cluster. Default node cluster is 3.



Required? false

Position? 3

Default value 3

Accept pipeline input? false

Accept wildcard characters? false



-SingleNode [<SwitchParameter>]

Enable CouchDB cluster in a single node.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-BindAddress <String>

The IP address to which to bind the current node.

The special value 0.0.0.0 (default) may be specified to bind to all interfaces on the host. (enable_cluster

and enable_single_node only)



Required? false

Position? 4

Default value 0.0.0.0

Accept pipeline input? false

Accept wildcard characters? false



-BindPort <Int32>

The TCP port to which to bind this node (enable_cluster and enable_single_node only).



Required? false

Position? 5

Default value 5984

Accept pipeline input? false

Accept wildcard characters? false



-RemoteNode <String>

The IP address of the remote node to setup as part of this cluster??????????????????s list of nodes. (enable_cluster only)



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RemoteUser <String>

The username of the server-level administrator authorized on the remote node. (enable_cluster only)



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RemotePassword <SecureString>

The password of the server-level administrator authorized on the remote node. (enable_cluster only)



Required? false

Position? 8

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Authorization <String>

The CouchDB authorization form; user and password.

Authorization format like this: user:password

ATTENTION: if the password is not specified, it will be prompted.



Required? false

Position? 9

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Ssl [<SwitchParameter>]

Set ssl connection on CouchDB server.

This modify protocol to https and port to 6984.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





CouchDB API:

POST /_cluster_setup



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Enable-CouchDBCluster -SingleNode -Authorization "admin:password"



This example get a cluster setup.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... html#setup