New-PveClusterMetricsServer

Create a new external metric server config

API: POST /cluster/metrics/server/{id}, Proxmox VE API viewer

Syntax

New-PveClusterMetricsServer
    [-PveTicket <PveTicket>]
    [-ApiPathPrefix <string>]
    [-Bucket <string>]
    [-Disable <bool>]
    -Id <string>
    [-Influxdbproto <string>]
    [-MaxBodySize <int>]
    [-Mtu <int>]
    [-Organization <string>]
    [-OtelCompression <string>]
    [-OtelHeaders <string>]
    [-OtelMaxBodySize <int>]
    [-OtelPath <string>]
    [-OtelProtocol <string>]
    [-OtelResourceAttributes <string>]
    [-OtelTimeout <int>]
    [-OtelVerifySsl <bool>]
    [-Path <string>]
    -Port <int>
    [-Proto <string>]
    -Server <string>
    [-Timeout <int>]
    [-Token <string>]
    -Type <string>
    [-VerifyCertificate <bool>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-ApiPathPrefix	string	No	An API path prefix inserted between ‘<host>:<port>/’ and ‘/api2/’. Can be useful if the InfluxDB service runs behind a reverse proxy.
-Bucket	string	No	The InfluxDB bucket/db. Only necessary when using the http v2 api.
-Disable	bool	No	Flag to disable the plugin.
-Id	string	Yes	The ID of the entry.
-Influxdbproto	string	No	Values: udp, http, https.
-MaxBodySize	int	No	InfluxDB max-body-size in bytes. Requests are batched up to this size.
-Mtu	int	No	MTU for metrics transmission over UDP.
-Organization	string	No	The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.
-OtelCompression	string	No	Compression algorithm for requests. Values: none, gzip.
-OtelHeaders	string	No	Custom HTTP headers (JSON format, base64 encoded)
-OtelMaxBodySize	int	No	Maximum request body size in bytes.
-OtelPath	string	No	OTLP endpoint path.
-OtelProtocol	string	No	HTTP protocol. Values: http, https.
-OtelResourceAttributes	string	No	Additional resource attributes as JSON, base64 encoded.
-OtelTimeout	int	No	HTTP request timeout in seconds.
-OtelVerifySsl	bool	No	Verify SSL certificates.
-Path	string	No	root graphite path (ex: proxmox.mycluster.mykey)
-Port	int	Yes	server network port.
-Proto	string	No	Protocol to send graphite data. TCP or UDP (default) Values: udp, tcp.
-Server	string	Yes	server dns name or IP address.
-Timeout	int	No	graphite TCP socket timeout (default=1)
-Token	string	No	The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use ‘user:password’ instead.
-Type	string	Yes	Plugin type. Values: graphite, influxdb, opentelemetry.
-VerifyCertificate	bool	No	Set to 0 to disable certificate verification for https endpoints.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.