Get-CouchDBServer

NAME Get-CouchDBServer



SYNOPSIS

Get server information.





SYNTAX

Get-CouchDBServer [[-Server] <String>] [[-Port] <Int32>] [[-Authorization] <String>] [-Status] [-Ssl]

[<CommonParameters>]





DESCRIPTION

Accessing the root of a CouchDB instance returns meta information about the instance.





PARAMETERS

-Server <String>

The CouchDB server name. Default is localhost.



Required? false

Position? 1

Default value

Accept pipeline input? false

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



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

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Status [<SwitchParameter>]

Get the status of server. API _up.



Required? false

Position? named

Default value False

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 /

GET /_up



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



PS C:\\>Get-CouchDBServer



This example get a meta information of localhost server.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-CouchDBServer -Serer couchdb1.local -Port 8080 -Status



This example get a status of couchdb1.local server with custom port.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... -operation