Get-CouchDBConfiguration

NAME Get-CouchDBConfiguration



SYNOPSIS

Get configuration.





SYNTAX

Get-CouchDBConfiguration [[-Server] <String>] [[-Port] <Int32>] [[-Node] <String>] [[-Session] <String>] [[-Key]

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





DESCRIPTION

Get configuration of 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



-Node <String>

The CouchDB node of cluster. Default is couchdb@localhost.



Required? false

Position? 3

Default value $(if ((Get-CouchDBNode -Server $Server -Port $Port -Authorization $Authorization

-Ssl:$Ssl).all_nodes -contains "couchdb@localhost") { "couchdb@localhost" } else { "couchdb@127.0.0.1" })

Accept pipeline input? false

Accept wildcard characters? false



-Session <String>

The CouchDB configuration section name.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Key <String>

The CouchDB configuration option name.



Required? false

Position? 5

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? 6

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:

GET /_node/{node-name}/_config

GET /_node/{node-name}/_config/{section}

GET /_node/{node-name}/_config/{section}/{key}



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



PS C:\\>Get-CouchDBConfiguration



This example get the localhost configuration of CouchDB server.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... figuration