nodes

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 17, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Cf_AVERAGE Cf = "AVERAGE"
	Cf_MAX     Cf = "MAX"

	Cmd_CEPH_INSTALL Cmd = "ceph_install"
	Cmd_UPGRADE      Cmd = "upgrade"
	Cmd_LOGIN        Cmd = "login"

	Command_REBOOT   Command = "reboot"
	Command_SHUTDOWN Command = "shutdown"

	Property_ACME                  Property = "acme"
	Property_ACMEDOMAIN0           Property = "acmedomain0"
	Property_ACMEDOMAIN1           Property = "acmedomain1"
	Property_ACMEDOMAIN2           Property = "acmedomain2"
	Property_ACMEDOMAIN3           Property = "acmedomain3"
	Property_ACMEDOMAIN4           Property = "acmedomain4"
	Property_ACMEDOMAIN5           Property = "acmedomain5"
	Property_DESCRIPTION           Property = "description"
	Property_STARTALL_ONBOOT_DELAY Property = "startall-onboot-delay"
	Property_WAKEONLAN             Property = "wakeonlan"

	Status_UNKNOWN Status = "unknown"
	Status_ONLINE  Status = "online"
	Status_OFFLINE Status = "offline"

	Timeframe_HOUR  Timeframe = "hour"
	Timeframe_DAY   Timeframe = "day"
	Timeframe_WEEK  Timeframe = "week"
	Timeframe_MONTH Timeframe = "month"
	Timeframe_YEAR  Timeframe = "year"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Acme added in v0.0.10 

type Acme struct {

	// The following parameters are optional
	Account *string `url:"account,omitempty" json:"account,omitempty"` // ACME account config file name.
	Domains *string `url:"domains,omitempty" json:"domains,omitempty"` // List of domains for this node's ACME certificate
}

Node specific ACME settings.

func (Acme) EncodeValues added in v0.0.10 

func (t Acme) EncodeValues(key string, v *url.Values) error

func (*Acme) UnmarshalJSON added in v0.0.19 

func (t *Acme) UnmarshalJSON(d []byte) error

type Acmedomain added in v0.0.15 

type Acmedomain struct {
	Domain string `url:"domain" json:"domain"` // domain for this node's ACME certificate

	// The following parameters are optional
	Alias  *string `url:"alias,omitempty" json:"alias,omitempty"`   // Alias for the Domain to verify ACME Challenge over DNS
	Plugin *string `url:"plugin,omitempty" json:"plugin,omitempty"` // The ACME plugin ID
}

ACME domain and validation plugin

func (Acmedomain) EncodeValues added in v0.0.15 

func (t Acmedomain) EncodeValues(key string, v *url.Values) error

func (*Acmedomain) UnmarshalJSON added in v0.0.19 

func (t *Acmedomain) UnmarshalJSON(d []byte) error

type Acmedomains added in v0.0.15 

type Acmedomains []*Acmedomain

Array of Acmedomain

func (Acmedomains) EncodeValues added in v0.0.15 

func (t Acmedomains) EncodeValues(key string, v *url.Values) error

type AplDownloadAplinfoRequest 

type AplDownloadAplinfoRequest struct {
	Node     string `url:"node" json:"node"`         // The cluster node name.
	Storage  string `url:"storage" json:"storage"`   // The storage where the template will be stored
	Template string `url:"template" json:"template"` // The template which will downloaded

}

type AplinfoRequest 

type AplinfoRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type Cf added in v0.0.15 

type Cf string

func PtrCf added in v0.0.15 

func PtrCf(i Cf) *Cf

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func New 

func New(c HTTPClient) *Client

func (*Client) AplDownloadAplinfo 

func (c *Client) AplDownloadAplinfo(ctx context.Context, req AplDownloadAplinfoRequest) (string, error)

AplDownloadAplinfo Download appliance templates.

func (*Client) Aplinfo 

func (c *Client) Aplinfo(ctx context.Context, req AplinfoRequest) ([]map[string]interface{}, error)

Aplinfo Get list of appliances.

func (*Client) DeleteSubscription 

func (c *Client) DeleteSubscription(ctx context.Context, req DeleteSubscriptionRequest) error

DeleteSubscription Delete subscription key of this node.

func (*Client) Dns 

func (c *Client) Dns(ctx context.Context, req DnsRequest) (DnsResponse, error)

Dns Read DNS settings.

func (*Client) Execute 

func (c *Client) Execute(ctx context.Context, req ExecuteRequest) ([]map[string]interface{}, error)

Execute Execute multiple commands in order.

func (*Client) Find 

func (c *Client) Find(ctx context.Context, req FindRequest) ([]map[string]interface{}, error)

Find Node index.

func (*Client) GetConfig 

func (c *Client) GetConfig(ctx context.Context, req GetConfigRequest) (GetConfigResponse, error)

GetConfig Get node configuration options.

func (*Client) GetEtcHosts 

func (c *Client) GetEtcHosts(ctx context.Context, req GetEtcHostsRequest) (GetEtcHostsResponse, error)

GetEtcHosts Get the content of /etc/hosts.

func (*Client) GetSubscription 

func (c *Client) GetSubscription(ctx context.Context, req GetSubscriptionRequest) (map[string]interface{}, error)

GetSubscription Read subscription info.

func (*Client) Index 

func (c *Client) Index(ctx context.Context) ([]IndexResponse, error)

Index Cluster node index.

func (*Client) Journal 

func (c *Client) Journal(ctx context.Context, req JournalRequest) ([]string, error)

Journal Read Journal

func (*Client) Migrateall 

func (c *Client) Migrateall(ctx context.Context, req MigrateallRequest) (string, error)

Migrateall Migrate all VMs and Containers.

func (*Client) Netstat 

func (c *Client) Netstat(ctx context.Context, req NetstatRequest) ([]map[string]interface{}, error)

Netstat Read tap/vm network device interface counters

func (*Client) NodeCmdStatus 

func (c *Client) NodeCmdStatus(ctx context.Context, req NodeCmdStatusRequest) error

NodeCmdStatus Reboot or shutdown a node.

func (*Client) QueryUrlMetadata 

func (c *Client) QueryUrlMetadata(ctx context.Context, req QueryUrlMetadataRequest) (QueryUrlMetadataResponse, error)

QueryUrlMetadata Query metadata of an URL: file size, file name and mime type.

func (*Client) Report 

func (c *Client) Report(ctx context.Context, req ReportRequest) (string, error)

Report Gather various systems information about a node

func (*Client) Rrd 

func (c *Client) Rrd(ctx context.Context, req RrdRequest) (RrdResponse, error)

Rrd Read node RRD statistics (returns PNG)

func (*Client) Rrddata 

func (c *Client) Rrddata(ctx context.Context, req RrddataRequest) ([]map[string]interface{}, error)

Rrddata Read node RRD statistics

func (*Client) SetOptionsConfig 

func (c *Client) SetOptionsConfig(ctx context.Context, req SetOptionsConfigRequest) error

SetOptionsConfig Set node configuration options.

func (*Client) SetSubscription 

func (c *Client) SetSubscription(ctx context.Context, req SetSubscriptionRequest) error

SetSubscription Set subscription key.

func (*Client) SetTimezoneTime 

func (c *Client) SetTimezoneTime(ctx context.Context, req SetTimezoneTimeRequest) error

SetTimezoneTime Set time zone.

func (*Client) Spiceshell 

func (c *Client) Spiceshell(ctx context.Context, req SpiceshellRequest) (SpiceshellResponse, error)

Spiceshell Creates a SPICE shell.

func (*Client) Startall 

func (c *Client) Startall(ctx context.Context, req StartallRequest) (string, error)

Startall Start all VMs and containers located on this node (by default only those with onboot=1).

func (*Client) Status 

func (c *Client) Status(ctx context.Context, req StatusRequest) (map[string]interface{}, error)

Status Read node status

func (*Client) Stopall 

func (c *Client) Stopall(ctx context.Context, req StopallRequest) (string, error)

Stopall Stop all VMs and Containers.

func (*Client) Syslog 

func (c *Client) Syslog(ctx context.Context, req SyslogRequest) ([]SyslogResponse, error)

Syslog Read system log

func (*Client) Termproxy 

func (c *Client) Termproxy(ctx context.Context, req TermproxyRequest) (TermproxyResponse, error)

Termproxy Creates a VNC Shell proxy.

func (*Client) Time 

func (c *Client) Time(ctx context.Context, req TimeRequest) (TimeResponse, error)

Time Read server time and time zone settings.

func (*Client) UpdateDns 

func (c *Client) UpdateDns(ctx context.Context, req UpdateDnsRequest) error

UpdateDns Write DNS settings.

func (*Client) UpdateSubscription 

func (c *Client) UpdateSubscription(ctx context.Context, req UpdateSubscriptionRequest) error

UpdateSubscription Update subscription info.

func (*Client) Version 

func (c *Client) Version(ctx context.Context, req VersionRequest) (VersionResponse, error)

Version API version details

func (*Client) Vncshell 

func (c *Client) Vncshell(ctx context.Context, req VncshellRequest) (VncshellResponse, error)

Vncshell Creates a VNC Shell proxy.

func (*Client) Vncwebsocket 

func (c *Client) Vncwebsocket(ctx context.Context, req VncwebsocketRequest) (VncwebsocketResponse, error)

Vncwebsocket Opens a websocket for VNC traffic.

func (*Client) Wakeonlan 

func (c *Client) Wakeonlan(ctx context.Context, req WakeonlanRequest) (string, error)

Wakeonlan Try to wake a node via 'wake on LAN' network packet.

func (*Client) WriteEtcHosts 

func (c *Client) WriteEtcHosts(ctx context.Context, req WriteEtcHostsRequest) error

WriteEtcHosts Write /etc/hosts.

type Cmd added in v0.0.15 

type Cmd string

func PtrCmd added in v0.0.15 

func PtrCmd(i Cmd) *Cmd

type Command added in v0.0.15 

type Command string

func PtrCommand added in v0.0.15 

func PtrCommand(i Command) *Command

type DeleteSubscriptionRequest 

type DeleteSubscriptionRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type DnsRequest 

type DnsRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type DnsResponse 

type DnsResponse struct {

	// The following parameters are optional
	Dns1   *string `url:"dns1,omitempty" json:"dns1,omitempty"`     // First name server IP address.
	Dns2   *string `url:"dns2,omitempty" json:"dns2,omitempty"`     // Second name server IP address.
	Dns3   *string `url:"dns3,omitempty" json:"dns3,omitempty"`     // Third name server IP address.
	Search *string `url:"search,omitempty" json:"search,omitempty"` // Search domain for host-name lookup.
}

type ExecuteRequest 

type ExecuteRequest struct {
	Commands string `url:"commands" json:"commands"` // JSON encoded array of commands.
	Node     string `url:"node" json:"node"`         // The cluster node name.

}

type FindRequest 

type FindRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type GetConfigRequest 

type GetConfigRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Property *Property `url:"property,omitempty" json:"property,omitempty"` // Return only a specific property from the node configuration.
}

type GetConfigResponse 

type GetConfigResponse struct {

	// The following parameters are optional
	Acme                *Acme        `url:"acme,omitempty" json:"acme,omitempty"`                                   // Node specific ACME settings.
	Acmedomains         *Acmedomains `url:"acmedomain[n],omitempty" json:"acmedomain[n],omitempty"`                 // ACME domain and validation plugin
	Description         *string      `url:"description,omitempty" json:"description,omitempty"`                     // Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.
	Digest              *string      `url:"digest,omitempty" json:"digest,omitempty"`                               // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	StartallOnbootDelay *int         `url:"startall-onboot-delay,omitempty" json:"startall-onboot-delay,omitempty"` // Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
	Wakeonlan           *string      `url:"wakeonlan,omitempty" json:"wakeonlan,omitempty"`                         // MAC address for wake on LAN
}

func (*GetConfigResponse) UnmarshalJSON added in v0.0.19 

func (t *GetConfigResponse) UnmarshalJSON(d []byte) error

type GetEtcHostsRequest 

type GetEtcHostsRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type GetEtcHostsResponse 

type GetEtcHostsResponse struct {
	Data string `url:"data" json:"data"` // The content of /etc/hosts.

	// The following parameters are optional
	Digest *string `url:"digest,omitempty" json:"digest,omitempty"` // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
}

type GetSubscriptionRequest 

type GetSubscriptionRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type HTTPClient 

type HTTPClient interface {
	Do(context.Context, string, string, interface{}, interface{}) error
}

type IndexResponse 

type IndexResponse struct {
	Node   string `url:"node" json:"node"`     // The cluster node name.
	Status Status `url:"status" json:"status"` // Node status.

	// The following parameters are optional
	Cpu            *float64 `url:"cpu,omitempty" json:"cpu,omitempty"`                         // CPU utilization.
	Level          *string  `url:"level,omitempty" json:"level,omitempty"`                     // Support level.
	Maxcpu         *int     `url:"maxcpu,omitempty" json:"maxcpu,omitempty"`                   // Number of available CPUs.
	Maxmem         *int     `url:"maxmem,omitempty" json:"maxmem,omitempty"`                   // Number of available memory in bytes.
	Mem            *int     `url:"mem,omitempty" json:"mem,omitempty"`                         // Used memory in bytes.
	SslFingerprint *string  `url:"ssl_fingerprint,omitempty" json:"ssl_fingerprint,omitempty"` // The SSL fingerprint for the node certificate.
	Uptime         *int     `url:"uptime,omitempty" json:"uptime,omitempty"`                   // Node uptime in seconds.
}

type JournalRequest 

type JournalRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Endcursor   *string `url:"endcursor,omitempty" json:"endcursor,omitempty"`     // End before the given Cursor. Conflicts with 'until'
	Lastentries *int    `url:"lastentries,omitempty" json:"lastentries,omitempty"` // Limit to the last X lines. Conflicts with a range.
	Since       *int    `url:"since,omitempty" json:"since,omitempty"`             // Display all log since this UNIX epoch. Conflicts with 'startcursor'.
	Startcursor *string `url:"startcursor,omitempty" json:"startcursor,omitempty"` // Start after the given Cursor. Conflicts with 'since'
	Until       *int    `url:"until,omitempty" json:"until,omitempty"`             // Display all log until this UNIX epoch. Conflicts with 'endcursor'.
}

type MigrateallRequest 

type MigrateallRequest struct {
	Node   string `url:"node" json:"node"`     // The cluster node name.
	Target string `url:"target" json:"target"` // Target node.

	// The following parameters are optional
	Maxworkers     *int          `url:"maxworkers,omitempty" json:"maxworkers,omitempty"`             // Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!
	Vms            *string       `url:"vms,omitempty" json:"vms,omitempty"`                           // Only consider Guests with these IDs.
	WithLocalDisks *util.PVEBool `url:"with-local-disks,omitempty" json:"with-local-disks,omitempty"` // Enable live storage migration for local disk
}

type NetstatRequest 

type NetstatRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type NodeCmdStatusRequest 

type NodeCmdStatusRequest struct {
	Command Command `url:"command" json:"command"` // Specify the command.
	Node    string  `url:"node" json:"node"`       // The cluster node name.

}

type Property added in v0.0.15 

type Property string

func PtrProperty added in v0.0.15 

func PtrProperty(i Property) *Property

type QueryUrlMetadataRequest 

type QueryUrlMetadataRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.
	Url  string `url:"url" json:"url"`   // The URL to query the metadata from.

	// The following parameters are optional
	VerifyCertificates *util.PVEBool `url:"verify-certificates,omitempty" json:"verify-certificates,omitempty"` // If false, no SSL/TLS certificates will be verified.
}

type QueryUrlMetadataResponse 

type QueryUrlMetadataResponse struct {

	// The following parameters are optional
	Filename *string `url:"filename,omitempty" json:"filename,omitempty"`
	Mimetype *string `url:"mimetype,omitempty" json:"mimetype,omitempty"`
	Size     *int    `url:"size,omitempty" json:"size,omitempty"`
}

type ReportRequest 

type ReportRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type RrdRequest 

type RrdRequest struct {
	Ds        string    `url:"ds" json:"ds"`               // The list of datasources you want to display.
	Node      string    `url:"node" json:"node"`           // The cluster node name.
	Timeframe Timeframe `url:"timeframe" json:"timeframe"` // Specify the time frame you are interested in.

	// The following parameters are optional
	Cf *Cf `url:"cf,omitempty" json:"cf,omitempty"` // The RRD consolidation function
}

type RrdResponse 

type RrdResponse struct {
	Filename string `url:"filename" json:"filename"`
}

type RrddataRequest 

type RrddataRequest struct {
	Node      string    `url:"node" json:"node"`           // The cluster node name.
	Timeframe Timeframe `url:"timeframe" json:"timeframe"` // Specify the time frame you are interested in.

	// The following parameters are optional
	Cf *Cf `url:"cf,omitempty" json:"cf,omitempty"` // The RRD consolidation function
}

type SetOptionsConfigRequest 

type SetOptionsConfigRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Acme                *Acme        `url:"acme,omitempty" json:"acme,omitempty"`                                   // Node specific ACME settings.
	Acmedomains         *Acmedomains `url:"acmedomain[n],omitempty" json:"acmedomain[n],omitempty"`                 // ACME domain and validation plugin
	Delete              *string      `url:"delete,omitempty" json:"delete,omitempty"`                               // A list of settings you want to delete.
	Description         *string      `url:"description,omitempty" json:"description,omitempty"`                     // Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.
	Digest              *string      `url:"digest,omitempty" json:"digest,omitempty"`                               // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	StartallOnbootDelay *int         `url:"startall-onboot-delay,omitempty" json:"startall-onboot-delay,omitempty"` // Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
	Wakeonlan           *string      `url:"wakeonlan,omitempty" json:"wakeonlan,omitempty"`                         // MAC address for wake on LAN
}

func (*SetOptionsConfigRequest) UnmarshalJSON added in v0.0.19 

func (t *SetOptionsConfigRequest) UnmarshalJSON(d []byte) error

type SetSubscriptionRequest 

type SetSubscriptionRequest struct {
	Key  string `url:"key" json:"key"`   // Proxmox VE subscription key
	Node string `url:"node" json:"node"` // The cluster node name.

}

type SetTimezoneTimeRequest 

type SetTimezoneTimeRequest struct {
	Node     string `url:"node" json:"node"`         // The cluster node name.
	Timezone string `url:"timezone" json:"timezone"` // Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.

}

type SpiceshellRequest 

type SpiceshellRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Cmd     *Cmd    `url:"cmd,omitempty" json:"cmd,omitempty"`           // Run specific command or default to login.
	CmdOpts *string `url:"cmd-opts,omitempty" json:"cmd-opts,omitempty"` // Add parameters to a command. Encoded as null terminated strings.
	Proxy   *string `url:"proxy,omitempty" json:"proxy,omitempty"`       // SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).
}

type SpiceshellResponse 

type SpiceshellResponse struct {
	Host     string `url:"host" json:"host"`
	Password string `url:"password" json:"password"`
	Proxy    string `url:"proxy" json:"proxy"`
	TlsPort  int    `url:"tls-port" json:"tls-port"`
	Type     string `url:"type" json:"type"`
}

Returned values can be directly passed to the 'remote-viewer' application.

type StartallRequest 

type StartallRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Force *util.PVEBool `url:"force,omitempty" json:"force,omitempty"` // Issue start command even if virtual guest have 'onboot' not set or set to off.
	Vms   *string       `url:"vms,omitempty" json:"vms,omitempty"`     // Only consider guests from this comma separated list of VMIDs.
}

type Status added in v0.0.15 

type Status string

func PtrStatus added in v0.0.15 

func PtrStatus(i Status) *Status

type StatusRequest 

type StatusRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type StopallRequest 

type StopallRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	ForceStop *util.PVEBool `url:"force-stop,omitempty" json:"force-stop,omitempty"` // Force a hard-stop after the timeout.
	Timeout   *int          `url:"timeout,omitempty" json:"timeout,omitempty"`       // Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced.
	Vms       *string       `url:"vms,omitempty" json:"vms,omitempty"`               // Only consider Guests with these IDs.
}

type SyslogRequest 

type SyslogRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Limit   *int    `url:"limit,omitempty" json:"limit,omitempty"`
	Service *string `url:"service,omitempty" json:"service,omitempty"` // Service ID
	Since   *string `url:"since,omitempty" json:"since,omitempty"`     // Display all log since this date-time string.
	Start   *int    `url:"start,omitempty" json:"start,omitempty"`
	Until   *string `url:"until,omitempty" json:"until,omitempty"` // Display all log until this date-time string.
}

type SyslogResponse 

type SyslogResponse struct {
	N int    `url:"n" json:"n"` // Line number
	T string `url:"t" json:"t"` // Line text

}

type TermproxyRequest 

type TermproxyRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Cmd     *Cmd    `url:"cmd,omitempty" json:"cmd,omitempty"`           // Run specific command or default to login.
	CmdOpts *string `url:"cmd-opts,omitempty" json:"cmd-opts,omitempty"` // Add parameters to a command. Encoded as null terminated strings.
}

type TermproxyResponse 

type TermproxyResponse struct {
	Port   int    `url:"port" json:"port"`
	Ticket string `url:"ticket" json:"ticket"`
	Upid   string `url:"upid" json:"upid"`
	User   string `url:"user" json:"user"`
}

type TimeRequest 

type TimeRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type TimeResponse 

type TimeResponse struct {
	Localtime int    `url:"localtime" json:"localtime"` // Seconds since 1970-01-01 00:00:00 (local time)
	Time      int    `url:"time" json:"time"`           // Seconds since 1970-01-01 00:00:00 UTC.
	Timezone  string `url:"timezone" json:"timezone"`   // Time zone

}

type Timeframe added in v0.0.15 

type Timeframe string

func PtrTimeframe added in v0.0.15 

func PtrTimeframe(i Timeframe) *Timeframe

type UpdateDnsRequest 

type UpdateDnsRequest struct {
	Node   string `url:"node" json:"node"`     // The cluster node name.
	Search string `url:"search" json:"search"` // Search domain for host-name lookup.

	// The following parameters are optional
	Dns1 *string `url:"dns1,omitempty" json:"dns1,omitempty"` // First name server IP address.
	Dns2 *string `url:"dns2,omitempty" json:"dns2,omitempty"` // Second name server IP address.
	Dns3 *string `url:"dns3,omitempty" json:"dns3,omitempty"` // Third name server IP address.
}

type UpdateSubscriptionRequest 

type UpdateSubscriptionRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Force *util.PVEBool `url:"force,omitempty" json:"force,omitempty"` // Always connect to server, even if we have up to date info inside local cache.
}

type VersionRequest 

type VersionRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type VersionResponse 

type VersionResponse struct {
	Release string `url:"release" json:"release"` // The current installed Proxmox VE Release
	Repoid  string `url:"repoid" json:"repoid"`   // The short git commit hash ID from which this version was build
	Version string `url:"version" json:"version"` // The current installed pve-manager package version

}

type VncshellRequest 

type VncshellRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Cmd       *Cmd          `url:"cmd,omitempty" json:"cmd,omitempty"`             // Run specific command or default to login.
	CmdOpts   *string       `url:"cmd-opts,omitempty" json:"cmd-opts,omitempty"`   // Add parameters to a command. Encoded as null terminated strings.
	Height    *int          `url:"height,omitempty" json:"height,omitempty"`       // sets the height of the console in pixels.
	Websocket *util.PVEBool `url:"websocket,omitempty" json:"websocket,omitempty"` // use websocket instead of standard vnc.
	Width     *int          `url:"width,omitempty" json:"width,omitempty"`         // sets the width of the console in pixels.
}

type VncshellResponse 

type VncshellResponse struct {
	Cert   string `url:"cert" json:"cert"`
	Port   int    `url:"port" json:"port"`
	Ticket string `url:"ticket" json:"ticket"`
	Upid   string `url:"upid" json:"upid"`
	User   string `url:"user" json:"user"`
}

type VncwebsocketRequest 

type VncwebsocketRequest struct {
	Node      string `url:"node" json:"node"`           // The cluster node name.
	Port      int    `url:"port" json:"port"`           // Port number returned by previous vncproxy call.
	Vncticket string `url:"vncticket" json:"vncticket"` // Ticket from previous call to vncproxy.

}

type VncwebsocketResponse 

type VncwebsocketResponse struct {
	Port string `url:"port" json:"port"`
}

type WakeonlanRequest 

type WakeonlanRequest struct {
	Node string `url:"node" json:"node"` // target node for wake on LAN packet

}

type WriteEtcHostsRequest 

type WriteEtcHostsRequest struct {
	Data string `url:"data" json:"data"` // The target content of /etc/hosts.
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Digest *string `url:"digest,omitempty" json:"digest,omitempty"` // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
}

Source Files

View all Source files

Directories

Path Synopsis
qemu
cfg
fs
mds
mgr
mon
osd
pool
pools
acme
directory
lvm
lvmthin
zfs
rules
pci
lxc
firewall
firewall/aliases
firewall/ipset
firewall/rules
snapshot
status
agent
cloudinit
firewall
firewall/aliases
firewall/ipset
firewall/rules
snapshot
status
sdn
zones
content
file_restore

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.